From 2141d942620734ce017d4eeb185bb3c9c79abd2b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 23:41:25 +0000 Subject: [PATCH 01/75] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4900bbf..28ff0f0 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.1.1", "@stdlib/assert-is-string-array": "^0.1.1", "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From 2497b6a7707677ef9121ccc04c97f23d19c96b41 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 23:51:38 +0000 Subject: [PATCH 02/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 69 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 45 files changed, 6205 insertions(+), 4390 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index be7ba7e..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -211,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 040b6c7..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 8bfb072..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('null4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('null2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('null3c',i));if(!x(r))throw new TypeError(n('nullAS',r));if(!N(r,e))throw new TypeError(n('nullFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('null2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('null2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 34f7c37..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 dbe704b..26d6170 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..19449ba --- /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/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..badebcd --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 40cea2a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 691167c..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 28ff0f0..1fa66bd 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,48 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.1.0", - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/assert-is-string-array": "^0.1.1", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-arcsine": "^0.1.0", - "@stdlib/random-base-normal": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..8c78be5 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 334fdc51768db74261f7e688ee8fc4afdcc8fd0d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 8 Jan 2024 13:45:19 +0000 Subject: [PATCH 03/75] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3107760..57b1012 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.1.1", "@stdlib/assert-is-string-array": "^0.1.1", "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From a209ed9c8f91ca8ee00eea701a8ee0d10f98169d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 8 Jan 2024 13:45:46 +0000 Subject: [PATCH 04/75] Remove files --- index.d.ts | 202 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6384 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 26d6170..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - PRNG parameter - * @param param2 - PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 19449ba..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index badebcd..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 8c78be5..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e2df0aceb5cab742ec6c2d53084d0c52e7dfb45a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 8 Jan 2024 13:46:03 +0000 Subject: [PATCH 05/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 69 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 45 files changed, 6205 insertions(+), 4390 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index be7ba7e..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -211,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 040b6c7..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 8bfb072..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('null4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('null2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('null3c',i));if(!x(r))throw new TypeError(n('nullAS',r));if(!N(r,e))throw new TypeError(n('nullFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('null2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('null2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 34f7c37..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 dbe704b..26d6170 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..19449ba --- /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/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..badebcd --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 40cea2a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 691167c..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 57b1012..74738ce 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,48 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.1.0", - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/assert-is-string-array": "^0.1.1", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-arcsine": "^0.1.0", - "@stdlib/random-base-normal": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..df699e9 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 36815656e7b2d84c28a13ebf28a401ad129d4b06 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 8 Jan 2024 13:46:35 +0000 Subject: [PATCH 06/75] Update README.md for ESM bundle v0.1.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2471abb..a6f5235 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ limitations under the License. ## Usage ```javascript -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.1.0-esm/index.mjs'; ``` #### Random( prng, dtypes, dtype ) @@ -160,7 +160,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.1.0-esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From a05514f9feaca491521d01d0061a2efe1a388e61 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 8 Jan 2024 13:46:36 +0000 Subject: [PATCH 07/75] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a6f5235..2a4ad03 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/random-array-tools-binary/tags). For example, + ```javascript import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.1.0-esm/index.mjs'; ``` @@ -160,7 +165,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.1.0-esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From ad82fdb96df8de1bb6c70c82e13cadf2839d8099 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Jan 2024 10:14:29 +0000 Subject: [PATCH 08/75] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3107760..57b1012 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.1.1", "@stdlib/assert-is-string-array": "^0.1.1", "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From ef5be63cee1624798a9a5ed6a6c07e4276ebcc0f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Jan 2024 10:14:58 +0000 Subject: [PATCH 09/75] Remove files --- index.d.ts | 202 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6384 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 26d6170..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - PRNG parameter - * @param param2 - PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 19449ba..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index badebcd..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index df699e9..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 840dfa9d07a232b0a1372ba5ec27f7f81256055d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Jan 2024 10:15:21 +0000 Subject: [PATCH 10/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 69 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 45 files changed, 6205 insertions(+), 4390 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index be7ba7e..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -211,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 040b6c7..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 8bfb072..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('null4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('null2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('null3c',i));if(!x(r))throw new TypeError(n('nullAS',r));if(!N(r,e))throw new TypeError(n('nullFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('null2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('null2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..19449ba --- /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/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..badebcd --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 40cea2a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 691167c..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 57b1012..74738ce 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,48 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.1.0", - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/assert-is-string-array": "^0.1.1", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-arcsine": "^0.1.0", - "@stdlib/random-base-normal": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..29de147 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 08dae218662c4fcad0fa10d7575c6d1e726f0f62 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 09:02:35 +0000 Subject: [PATCH 11/75] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 3107760..57b1012 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.1.1", "@stdlib/assert-is-string-array": "^0.1.1", "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/string-format": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1", "@stdlib/types": "^0.2.0", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" }, From ed589ae8efa27f72b5aa9b40fd9dd7372d255b4c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:26:19 +0000 Subject: [PATCH 12/75] Remove files --- index.d.ts | 202 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6384 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 19449ba..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index badebcd..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 29de147..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 8f8300b41beb565064ac0a136cf5c0c236a77079 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 14:26:53 +0000 Subject: [PATCH 13/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 69 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 6205 insertions(+), 4396 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 31f90c3..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-02-01T06:20:13.816Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index be7ba7e..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..19449ba --- /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/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..badebcd --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 40cea2a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 691167c..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 57b1012..74738ce 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,48 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.1.0", - "@stdlib/array-base-filled-by": "^0.1.0", - "@stdlib/array-ctors": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-collection": "^0.1.0", - "@stdlib/assert-is-function": "^0.1.1", - "@stdlib/assert-is-nonnegative-integer": "^0.1.0", - "@stdlib/assert-is-plain-object": "^0.1.1", - "@stdlib/assert-is-string-array": "^0.1.1", - "@stdlib/strided-base-binary": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-arcsine": "^0.1.0", - "@stdlib/random-base-normal": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..93c137f --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 37e7870cccb04a6ee3cd54f3312f19961244071e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 01:10:34 +0000 Subject: [PATCH 14/75] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 77b4d34..6e9b7bf 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.0", "@stdlib/assert-is-string-array": "^0.2.0", "@stdlib/strided-base-binary": "^0.2.0", - "@stdlib/string-format": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0", "@stdlib/types": "^0.3.1", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" }, From aad41cd30b69c7d8f7377771efcf0c66af8a26aa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:41:44 +0000 Subject: [PATCH 15/75] Remove files --- index.d.ts | 202 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6384 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 19449ba..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.1.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.1.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.1.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.1.1-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index badebcd..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 93c137f..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 946cc7d02823698e8887fe0171329a572d261254 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:42:56 +0000 Subject: [PATCH 16/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 69 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 45 files changed, 6205 insertions(+), 4399 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) 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 c5ffe97..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/random/array/tools/binary) 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 9e7b9fe..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..25f5998 --- /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/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.0-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..badebcd --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 40cea2a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 691167c..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/string-format' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 6e9b7bf..6adce1b 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,48 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.0", - "@stdlib/array-base-filled-by": "^0.2.0", - "@stdlib/array-ctors": "^0.2.0", - "@stdlib/assert-has-own-property": "^0.2.0", - "@stdlib/assert-is-collection": "^0.2.0", - "@stdlib/assert-is-function": "^0.2.0", - "@stdlib/assert-is-nonnegative-integer": "^0.2.0", - "@stdlib/assert-is-plain-object": "^0.2.0", - "@stdlib/assert-is-string-array": "^0.2.0", - "@stdlib/strided-base-binary": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0", - "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.2.0", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-base-arcsine": "^0.1.0", - "@stdlib/random-base-normal": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c0a831c --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 1655cca6cc86d6ac5b8014b1b48faee4727c7fdd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:35:16 +0000 Subject: [PATCH 17/75] Update README.md for ESM bundle v0.2.0 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1084289..ad11c15 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ limitations under the License. ## Usage ```javascript -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.0-esm/index.mjs'; ``` #### Random( prng, dtypes, dtype ) @@ -160,7 +160,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.0-esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From 3f4d59bd781751a2b2eac9ef9e1911092f602f95 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:35:17 +0000 Subject: [PATCH 18/75] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ad11c15..7bfe517 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/random-array-tools-binary/tags). For example, + ```javascript import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.0-esm/index.mjs'; ``` @@ -160,7 +165,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.0-esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From 03421861e2645104eeaa896e9934ce696e62a9c3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 19:53:11 +0000 Subject: [PATCH 19/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 42541c2..3c64c6a 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.1", "@stdlib/assert-is-string-array": "^0.2.1", "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" From a56c8226dcece44b43de24e43d72ec8419aa2456 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:12:44 +0000 Subject: [PATCH 20/75] Remove files --- index.d.ts | 202 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6384 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 25f5998..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.0-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.1.0-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.1.0-esm/index.mjs";import a from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.1.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/string-format@v0.1.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.0-esm/index.mjs";import l from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.0-esm/index.mjs";function h(t,e,s){return p(s)?l(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m('invalid option. `%s` option must be one of the following: "%s". Option: `%s`.',"dtype",e.join('", "'),t.dtype)):null:new TypeError(m("invalid argument. Options argument must be an object. Value: `%s`.",s))}function u(t,e,n){if(!(this instanceof u))return new u(t,e,n);if(!s(t))throw new TypeError(m("invalid argument. First argument must be a function. Value: `%s`.",t));if(!r(e))throw new TypeError(m("invalid argument. Second argument must be an array of strings. Value: `%s`.",e));if(!i(e,n))throw new TypeError(m("invalid argument. Third argument must be a supported data type. Value: `%s`.",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(u.prototype,"generate",(function(t,s,r,n){var i,p,l,u,g;if(!e(t))throw new TypeError(m("invalid argument. First argument must be a nonnegative integer. Value: `%s`.",t));if(i={},arguments.length>3&&(u=h(i,this._dtypes,n)))throw u;return p=this._prng,"generic"===(g=i.dtype||this._dtype)?o(t,j):(l=new(a(g))(t),d([[s],[r],l],[t],[0,0,1],p),l);function j(){return p(s,r)}})),t(u.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("invalid argument. Third argument must be an array-like object. Value: `%s`.",s));return d([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{u as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index badebcd..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/validate.js","../lib/main.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 contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/string-format';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/string-format';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\n"],"names":["validate","opts","dtypes","options","isObject","hasOwnProp","dtype","contains","TypeError","format","join","Random","prng","this","isFunction","isStringArray","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","out","err","dt","isNonNegativeInteger","arguments","length","filledBy","wrapper","ctors","binary","isCollection"],"mappings":";;6qCAmDA,SAASA,EAAUC,EAAMC,EAAQC,GAChC,OAAMC,EAAUD,GAGXE,EAAYF,EAAS,WACzBF,EAAKK,MAAQH,EAAQG,OACfC,EAAUL,EAAQD,EAAKK,QACrB,IAAIE,UAAWC,EAAQ,gFAAiF,QAASP,EAAOQ,KAAM,QAAUT,EAAKK,QAG/I,KARC,IAAIE,UAAWC,EAAQ,qEAAsEN,GAStG,CCAA,SAASQ,EAAQC,EAAMV,EAAQI,GAC9B,KAAQO,gBAAgBF,GACvB,OAAO,IAAIA,EAAQC,EAAMV,EAAQI,GAElC,IAAMQ,EAAYF,GACjB,MAAM,IAAIJ,UAAWC,EAAQ,oEAAqEG,IAGnG,IAAMG,EAAeb,GACpB,MAAM,IAAIM,UAAWC,EAAQ,8EAA+EP,IAG7G,IAAMK,EAAUL,EAAQI,GACvB,MAAM,IAAIE,UAAWC,EAAQ,+EAAgFH,IAK9G,OAHAO,KAAKG,MAAQJ,EACbC,KAAKI,QAAUf,EACfW,KAAKK,OAASZ,EACPO,IACR,CA6BAM,EAAaR,EAAOS,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQpB,GAClF,IACIF,EACAW,EACAY,EACAC,EACAC,EACJ,IAAMC,EAAsBN,GAC3B,MAAM,IAAIb,UAAWC,EAAQ,+EAAgFY,IAG9G,GADApB,EAAO,CAAA,EACF2B,UAAUC,OAAS,IACvBJ,EAAMzB,EAAUC,EAAMY,KAAKI,QAASd,IAEnC,MAAMsB,EAMR,OAFAb,EAAOC,KAAKG,MAEA,aADZU,EAAKzB,EAAKK,OAASO,KAAKK,QAEhBY,EAAUT,EAAKU,IAGvBP,EAAM,IADCQ,EAAON,GACR,CAAUL,GAChBY,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEH,GAAO,CAAE,EAAG,EAAG,GAAKT,GACxDY,GAQP,SAASO,IACR,OAAOnB,EAAMU,EAAQC,EACrB,CACF,IAgCAJ,EAAaR,EAAOS,UAAW,UAAU,SAAiBE,EAAQC,EAAQC,GACzE,IAAMU,EAAcV,GACnB,MAAM,IAAIhB,UAAWC,EAAQ,8EAA+Ee,IAI7G,OADAS,EAAQ,CAAE,CAAEX,GAAU,CAAEC,GAAUC,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKhB,KAAKG,OACpEQ,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c0a831c..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 927116d8d19052aa95858130060783d4c11d189e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:13:12 +0000 Subject: [PATCH 21/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 -- examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 45 files changed, 4870 insertions(+), 4394 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) 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 c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..174fb57 --- /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/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 3c64c6a..31bb8b4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.1", - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/assert-is-string-array": "^0.2.1", - "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-zeros": "^0.2.0", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-arcsine": "^0.2.0", - "@stdlib/random-base-normal": "^0.2.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..161cbcf --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From fd59104c07ef7d37aeb3c28c45d312243faf3ee8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:52:34 +0000 Subject: [PATCH 22/75] Update README.md for ESM bundle v0.2.1 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a77a1b8..5f54f51 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ limitations under the License. ## Usage ```javascript -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.1-esm/index.mjs'; ``` #### Random( prng, dtypes, dtype ) @@ -160,7 +160,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.1-esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From 21bf485a0eecd558ff2f7a9260b2229876ab1dd8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:52:34 +0000 Subject: [PATCH 23/75] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5f54f51..30a0c36 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/random-array-tools-binary/tags). For example, + ```javascript import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.1-esm/index.mjs'; ``` @@ -160,7 +165,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.1-esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From fc7687f0016643fea5fa070bec84c8bb051fbef2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 08:19:24 +0000 Subject: [PATCH 24/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 7d0c528..f1eee4a 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.1", "@stdlib/assert-is-string-array": "^0.2.1", "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" From d5ca49a9f7322fa59786e07aa56457fba568a313 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:04:30 +0000 Subject: [PATCH 25/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 174fb57..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.0-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 161cbcf..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6f5eb131e8b77458a2479765b68b3338c1484068 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:04:50 +0000 Subject: [PATCH 26/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 -- examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4396 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index dd1b316..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T06:00:05.163Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) 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 c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..12e1946 --- /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/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index f1eee4a..31bb8b4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.1", - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/assert-is-string-array": "^0.2.1", - "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..395cc51 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 792745a8b9b0db790364a26ed2cafc2555bd611d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 07:35:30 +0000 Subject: [PATCH 27/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 7d0c528..f1eee4a 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.1", "@stdlib/assert-is-string-array": "^0.2.1", "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" From 786aaafa445e5394fe54cfa4f2f8e65d6adb0b84 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:05:35 +0000 Subject: [PATCH 28/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 12e1946..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 395cc51..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 28e8a8d4d9990ef6698cc625d26a1edfb34a44cf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:05:58 +0000 Subject: [PATCH 29/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 -- examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4399 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index df5a701..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:16:14.818Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) 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 c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..12e1946 --- /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/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index f1eee4a..31bb8b4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.1", - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/assert-is-string-array": "^0.2.1", - "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..395cc51 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 67435b59ba967e462d2f5565ddb8da16743756a2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 03:50:04 +0000 Subject: [PATCH 30/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 7d0c528..f1eee4a 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.1", "@stdlib/assert-is-string-array": "^0.2.1", "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/string-format": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", "@stdlib/error-tools-fmtprodmsg": "^0.2.1" From 4933fe53631ddbab5b0fc02d998ba260f72eb194 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:15:21 +0000 Subject: [PATCH 31/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 12e1946..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 395cc51..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 367d2b3a04b2404a666eacbefc8e9c93da2761c3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:15:40 +0000 Subject: [PATCH 32/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 134 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 -- examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 45 files changed, 4870 insertions(+), 4400 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) 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 c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..12e1946 --- /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/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index f1eee4a..31bb8b4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.1", - "@stdlib/array-base-filled-by": "^0.2.1", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-collection": "^0.2.1", - "@stdlib/assert-is-function": "^0.2.1", - "@stdlib/assert-is-nonnegative-integer": "^0.2.1", - "@stdlib/assert-is-plain-object": "^0.2.1", - "@stdlib/assert-is-string-array": "^0.2.1", - "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..395cc51 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 17b9befe692d154d90e612578216faf78664d863 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:21:33 +0000 Subject: [PATCH 33/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 34c326b..2aa3970 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.2", "@stdlib/assert-is-string-array": "^0.2.2", "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 28db95d67c531ee1c16d0d311bbcdb34fff984e5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:43:52 +0000 Subject: [PATCH 34/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 12e1946..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.1-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.1-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.2.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.2.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.1-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.1-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.1-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 395cc51..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f481d552d44a052cb372b176a435584df36da02a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:44:10 +0000 Subject: [PATCH 35/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 102 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 -- examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 45 files changed, 4870 insertions(+), 4510 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) 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 c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7ac834f --- /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/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 2aa3970..4ce2c30 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.1", - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-ctors": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/assert-is-string-array": "^0.2.2", - "@stdlib/strided-base-binary": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^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", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1b0bb96 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 612e29e4d6c14445945b810a150615342e14cee0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:50:43 +0000 Subject: [PATCH 36/75] Update README.md for ESM bundle v0.2.2 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 823ef44..3859810 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ limitations under the License. ## Usage ```javascript -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.2-esm/index.mjs'; ``` #### Random( prng, dtypes, dtype ) @@ -160,7 +160,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.2-esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From 860ce6f98649713c931ac0084c8495cd195acfc2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 29 Jul 2024 03:50:44 +0000 Subject: [PATCH 37/75] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3859810..c8a3818 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/random-array-tools-binary/tags). For example, + ```javascript import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.2-esm/index.mjs'; ``` @@ -160,7 +165,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.2-esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From 0e0d068f08cb8bc74165e65353c11a1e2ac3c673 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 08:27:05 +0000 Subject: [PATCH 38/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 658576c..d2e2653 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.2", "@stdlib/assert-is-string-array": "^0.2.2", "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.3.2", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From e043f43bb5b543a20c78f8825332959802cc45aa Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 13:22:55 +0000 Subject: [PATCH 39/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7ac834f..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.1-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1b0bb96..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 12bc003dc935f8dedf4b363461be0c42c2d58ed1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 13:23:14 +0000 Subject: [PATCH 40/75] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 78 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 -- examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4487 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index be49b08..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-01T06:09:57.706Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index b0ac9a4..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/random/array/tools/binary) 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 c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index acd4317..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, dtypes[ 0 ] ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d4a328a --- /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/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index d2e2653..4ce2c30 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.2", - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/assert-is-string-array": "^0.2.2", - "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^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", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..76705fb --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 700a73ebb175207ec3a317d140c8140319be2638 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 10:50:21 +0000 Subject: [PATCH 41/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 14d196f..a83748c 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.2", "@stdlib/assert-is-string-array": "^0.2.2", "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 8af092ed39cf12ac0e8e6dce1b567088d359c0fe Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 10:51:16 +0000 Subject: [PATCH 42/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d4a328a..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 76705fb..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d2e0d16e0de19d1f5ec2b26d96e712926ca809df Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 10:51:30 +0000 Subject: [PATCH 43/75] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 136 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4652 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..13f7cbe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index a83748c..4ce2c30 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.2", - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/assert-is-string-array": "^0.2.2", - "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^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", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..76705fb --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 7966e429ac42a171d92c374653a2ae583c90d14b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:04:08 +0000 Subject: [PATCH 44/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 14d196f..a83748c 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.2", "@stdlib/assert-is-string-array": "^0.2.2", "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From b9c47df7d77eb431d8508e538e6f024f3839cb54 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:25:29 +0000 Subject: [PATCH 45/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 13f7cbe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 76705fb..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e4d86f040eb5f5a12026041fc6edff301425c7c2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 19 May 2025 02:25:48 +0000 Subject: [PATCH 46/75] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 136 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 47 files changed, 4870 insertions(+), 4653 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index c33117f..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-05-19T02:00:05.738Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 521ce36..39e5ee1 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..13f7cbe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index a83748c..4ce2c30 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.2", - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/assert-is-string-array": "^0.2.2", - "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^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", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..76705fb --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From b488d3c35de726a98952c86583b50159a3e57b56 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 5 Dec 2025 05:56:45 +0000 Subject: [PATCH 47/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 14d196f..a83748c 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.2", "@stdlib/assert-is-string-array": "^0.2.2", "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 0ea427ebdf3d7898421e602ee073edf617af07b8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 5 Dec 2025 06:01:22 +0000 Subject: [PATCH 48/75] Remove files --- index.d.ts | 202 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5049 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 39e5ee1..0000000 --- a/index.d.ts +++ /dev/null @@ -1,202 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 13f7cbe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 76705fb..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5890595760e7a914dfff9229f0c486d22f044897 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 5 Dec 2025 06:01:41 +0000 Subject: [PATCH 49/75] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4659 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..13f7cbe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index a83748c..4ce2c30 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.2", - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/assert-is-string-array": "^0.2.2", - "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^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", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..76705fb --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 9a062215cd693c38b21920ec1c0b6f65803ff31a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 01:55:40 +0000 Subject: [PATCH 50/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index d49ff4a..6207985 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.2", "@stdlib/assert-is-string-array": "^0.2.2", "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/string-format": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", "@stdlib/error-tools-fmtprodmsg": "^0.2.2" From 19a2fefb7f5b1c4dce7c86b9c2989fbe73633487 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 03:01:26 +0000 Subject: [PATCH 51/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 13f7cbe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 76705fb..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 44972b0f9c03e00d6a099aeb3f57b4f9c68484e8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 31 Jan 2026 03:01:51 +0000 Subject: [PATCH 52/75] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 108 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4759 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..95e7220 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 6207985..4ce2c30 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.2", - "@stdlib/array-base-filled-by": "^0.2.2", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-collection": "^0.2.2", - "@stdlib/assert-is-function": "^0.2.2", - "@stdlib/assert-is-nonnegative-integer": "^0.2.2", - "@stdlib/assert-is-plain-object": "^0.2.2", - "@stdlib/assert-is-string-array": "^0.2.2", - "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.0", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^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", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..76705fb --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 7627d52de213b8762ae377932562548ef6cabd58 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 18:17:44 +0000 Subject: [PATCH 53/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 269066c..35455bb 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.3", "@stdlib/assert-is-string-array": "^0.2.3", "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From 92a36a6d99145940edabda9cc3f1393429792999 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 19:16:22 +0000 Subject: [PATCH 54/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 95e7220..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.2-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.2-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.2-esm/index.mjs";import n 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-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.2-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.0-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.2-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.2-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.2-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 76705fb..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 6bd7c2d3864759be87ca4bb37616e80aa782ba83 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 19:16:39 +0000 Subject: [PATCH 55/75] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4752 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..53d5978 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 35455bb..1c3ddd9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.2", - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-ctors": "^0.3.0", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-collection": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/assert-is-string-array": "^0.2.3", - "@stdlib/strided-base-binary": "^0.3.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-base-arcsine": "^0.2.1", - "@stdlib/random-base-normal": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0c11931 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From c992ed00ae7ee7bb08af28e1f668e099e698ef34 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 19:40:42 +0000 Subject: [PATCH 56/75] Update README.md for ESM bundle v0.2.3 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46c2e14..e9594a2 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ limitations under the License. ## Usage ```javascript -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.3-esm/index.mjs'; ``` #### Random( prng, dtypes, dtype ) @@ -160,7 +160,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.3-esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From 828a4459734c9de3c241c8573d30906bea031888 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 19:40:42 +0000 Subject: [PATCH 57/75] Auto-generated commit --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e9594a2..cd0d5fe 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,11 @@ limitations under the License. ## Usage +```javascript +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/random-array-tools-binary/tags). For example, + ```javascript import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.3-esm/index.mjs'; ``` @@ -160,7 +165,7 @@ The method has the following parameters: import arcsine from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-base-arcsine@esm/index.mjs'; import dtypes from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@esm/index.mjs'; -import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@v0.2.3-esm/index.mjs'; +import Random from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-binary@esm/index.mjs'; var dt = dtypes( 'real_floating_point_and_generic' ); var random = new Random( arcsine, dt, 'float64' ); From 4878c931c320004cef93e02b6df2e861f804e164 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Feb 2026 02:57:16 +0000 Subject: [PATCH 58/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 1ea3dfc..17a1d25 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.3", "@stdlib/assert-is-string-array": "^0.2.3", "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From 01d6045f0b9e61a89429ab2e2e111a250e207186 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Feb 2026 04:48:22 +0000 Subject: [PATCH 59/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 53d5978..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.2-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.0-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0c11931..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ba5c388c172bca828043cb7d70b006956e7abdb8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Feb 2026 04:48:41 +0000 Subject: [PATCH 60/75] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 47 files changed, 4870 insertions(+), 4753 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 27a75f8..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-02-23T02:11:25.852Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1eb0220 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 17a1d25..1c3ddd9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.3", - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-ctors": "^0.3.1", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-collection": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/assert-is-string-array": "^0.2.3", - "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-base-arcsine": "^0.2.2", - "@stdlib/random-base-normal": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..17e1023 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 85a16b966b49f17abadeb6e6af6027fa09b9e199 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Mar 2026 03:24:28 +0000 Subject: [PATCH 61/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 1ea3dfc..17a1d25 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.3", "@stdlib/assert-is-string-array": "^0.2.3", "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From a91f7d13740f96199b2ec3cb71ef436c0fcd7b79 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Mar 2026 05:06:33 +0000 Subject: [PATCH 62/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1eb0220..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 17e1023..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e35fdaf1282cc5889eddb47cd038d6562a72c345 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Mar 2026 05:06:54 +0000 Subject: [PATCH 63/75] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 47 files changed, 4870 insertions(+), 4764 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index babef1a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-03-23T02:36:44.006Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1eb0220 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 17a1d25..1c3ddd9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.3", - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-ctors": "^0.3.1", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-collection": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/assert-is-string-array": "^0.2.3", - "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-base-arcsine": "^0.2.2", - "@stdlib/random-base-normal": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..17e1023 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From c229ae4a528993aac8a8f4cc90b490dfa0321363 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Apr 2026 03:31:14 +0000 Subject: [PATCH 64/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 1ea3dfc..17a1d25 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.3", "@stdlib/assert-is-string-array": "^0.2.3", "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From df1c3518fc0666eb41084e4f4a686d167d2978ce Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Apr 2026 03:47:43 +0000 Subject: [PATCH 65/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1eb0220..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 17e1023..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a621f850df189336102b8a0b2b54477ff06c38de Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Apr 2026 03:48:03 +0000 Subject: [PATCH 66/75] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 138 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 105 - benchmark/benchmark.generate.js | 101 - benchmark/benchmark.js | 93 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 47 files changed, 4870 insertions(+), 4764 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 3369a98..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-04-03T03:26:46.205Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 51da88b..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,105 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':assign:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index d3f6d47..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,101 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( pkg+':generate:len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ff9ab5f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,93 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( pkg+'::new', function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+'::no_new', function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1eb0220 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 17a1d25..1c3ddd9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.3", - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-ctors": "^0.3.1", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-collection": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/assert-is-string-array": "^0.2.3", - "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-base-arcsine": "^0.2.2", - "@stdlib/random-base-normal": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..17e1023 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 9b934cf91bb49abdb7a1b85cc0f6826c395d1457 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 13 Apr 2026 00:07:29 +0000 Subject: [PATCH 67/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 1ea3dfc..17a1d25 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.3", "@stdlib/assert-is-string-array": "^0.2.3", "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From 95d716b17fa602ad4e45ff442ecfc5855e6cc550 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 13 Apr 2026 00:56:43 +0000 Subject: [PATCH 68/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1eb0220..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 17e1023..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 633daa76c6305e690fd0e557ea8012cee64fae2b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 13 Apr 2026 00:57:01 +0000 Subject: [PATCH 69/75] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 106 - benchmark/benchmark.generate.js | 102 - benchmark/benchmark.js | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 46 files changed, 4870 insertions(+), 4800 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 637683f..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index e35df8b..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:generate:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index f6b6894..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::new', pkg ), function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s::no_new', pkg ), function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1eb0220 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 17a1d25..1c3ddd9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.3", - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-ctors": "^0.3.1", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-collection": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/assert-is-string-array": "^0.2.3", - "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-base-arcsine": "^0.2.2", - "@stdlib/random-base-normal": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..17e1023 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 74fa3125c8cb24cc4c79807ae28c362c0ec72170 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 11 May 2026 03:30:52 +0000 Subject: [PATCH 70/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index 1ea3dfc..17a1d25 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.3", "@stdlib/assert-is-string-array": "^0.2.3", "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.4.3", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From 9cc8542b769de5c50872c0a09e151e14486645c6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 11 May 2026 03:55:33 +0000 Subject: [PATCH 71/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1eb0220..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 17e1023..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4f4af8bb09b154d2f7047e474101d568ad50b25e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 11 May 2026 03:55:53 +0000 Subject: [PATCH 72/75] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 106 - benchmark/benchmark.generate.js | 102 - benchmark/benchmark.js | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 47 files changed, 4870 insertions(+), 4806 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index e104f5d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-11T03:24:08.210Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 637683f..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index e35df8b..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:generate:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index f6b6894..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::new', pkg ), function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s::no_new', pkg ), function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index f6abf82..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){return r||i((r={exports:{}}).exports,r),r.exports}};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 d052fc5..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1eb0220 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 17a1d25..1c3ddd9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.3", - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-ctors": "^0.3.1", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-collection": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/assert-is-string-array": "^0.2.3", - "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-base-arcsine": "^0.2.2", - "@stdlib/random-base-normal": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..17e1023 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -}); From 7e715fb16cf3c20b852ea06ae6a4bd633251f354 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 23 Jun 2026 03:48:31 +0000 Subject: [PATCH 73/75] Transform error messages --- lib/main.js | 12 ++++++------ lib/validate.js | 6 +++--- package.json | 2 +- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lib/main.js b/lib/main.js index 40cea2a..44fc597 100644 --- a/lib/main.js +++ b/lib/main.js @@ -31,7 +31,7 @@ var contains = require( '@stdlib/array-base-assert-contains' ); var filledBy = require( '@stdlib/array-base-filled-by' ); var binary = require( '@stdlib/strided-base-binary' ); var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); var validate = require( './validate.js' ); @@ -65,15 +65,15 @@ function Random( prng, dtypes, dtype ) { return new Random( prng, dtypes, dtype ); } if ( !isFunction( prng ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) ); + throw new TypeError( format( '1qj3c', prng ) ); } // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) ); + throw new TypeError( format( '1qjAS', dtypes ) ); } // Require that the default output array data type be a member of the list of supported output array data types... if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) ); + throw new TypeError( format( '1qjFO', dtype ) ); } this._prng = prng; this._dtypes = dtypes; @@ -116,7 +116,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param var err; var dt; if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) ); + throw new TypeError( format( '1qj2d', len ) ); } opts = {}; if ( arguments.length > 3 ) { @@ -179,7 +179,7 @@ setReadOnly( Random.prototype, 'generate', function generate( len, param1, param */ setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { if ( !isCollection( out ) ) { - throw new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) ); + throw new TypeError( format( '1qj2l', out ) ); } // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len diff --git a/lib/validate.js b/lib/validate.js index 691167c..4b4591b 100644 --- a/lib/validate.js +++ b/lib/validate.js @@ -23,7 +23,7 @@ var isObject = require( '@stdlib/assert-is-plain-object' ); var hasOwnProp = require( '@stdlib/assert-has-own-property' ); var contains = require( '@stdlib/array-base-assert-contains' ); -var format = require( '@stdlib/string-format' ); +var format = require( '@stdlib/error-tools-fmtprodmsg' ); // MAIN // @@ -51,12 +51,12 @@ var format = require( '@stdlib/string-format' ); */ function validate( opts, dtypes, options ) { if ( !isObject( options ) ) { - return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) ); + return new TypeError( format( '1qj2V', options ) ); } if ( hasOwnProp( options, 'dtype' ) ) { opts.dtype = options.dtype; if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); + return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); } } return null; diff --git a/package.json b/package.json index df00eb1..231ec16 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "@stdlib/assert-is-plain-object": "^0.2.3", "@stdlib/assert-is-string-array": "^0.2.3", "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/types": "^0.5.1", "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", "@stdlib/error-tools-fmtprodmsg": "^0.2.3" From 7252ddd2ee2350bb73a14c74260e6b849d47280e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 23 Jun 2026 04:05:53 +0000 Subject: [PATCH 74/75] Remove files --- index.d.ts | 204 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5051 deletions(-) delete mode 100644 index.d.ts delete mode 100644 index.mjs delete mode 100644 index.mjs.map delete mode 100644 stats.html diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index 5eb0681..0000000 --- a/index.d.ts +++ /dev/null @@ -1,204 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -// TypeScript Version: 4.1 - -/// - -import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; -import { PRNG } from '@stdlib/types/random'; - -/** -* Output array. -*/ -type OutputArray = ArrayLike | AccessorArrayLike; - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for generating pseudorandom values drawn from a binary PRNG. -*/ -interface BinaryPRNG extends PRNG { - /** - * Returns a pseudorandom value. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @returns pseudorandom value - */ - ( param1: T, param2: U ): V; -} - -/** -* Class for creating arrays filled with pseudorandom values drawn from a binary PRNG. -*/ -declare class RandomArray { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - constructor( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ); - - /** - * Returns an array filled with pseudorandom values drawn from a binary PRNG. - * - * @param len - number of elements - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param options - function options - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - generate( len: number, param1: T, param2: U, options?: Options ): OutputArray; - - /** - * Fills an array with pseudorandom values drawn from a binary PRNG. - * - * @param param1 - first PRNG parameter - * @param param2 - second PRNG parameter - * @param out - output array - * @returns output array - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * var zeros = require( '@stdlib/array-zeros' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var out = zeros( 10, 'float64' ); - * // returns - * - * var v = rand.assign( 2.0, 5.0, out ); - * // returns - * - * var bool = ( v === out ); - * // returns true - */ - assign( param1: T, param2: U, out: OutputArray ): OutputArray; -} - -/** -* Interface defining a constructor which is both "newable" and "callable". -*/ -interface RandomArrayConstructor { - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - new( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; - - /** - * Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. - * - * @param prng - binary pseudorandom value generator - * @param dtypes - list of supported output data types - * @param dtype - default output data type - * @returns instance - * - * @example - * var arcsine = require( '@stdlib/random-base-arcsine' ); - * - * var dtypes = [ 'float64', 'float32', 'generic' ]; - * var defaultDType = 'float64'; - * - * var rand = new RandomArray( arcsine, dtypes, defaultDType ); - * - * var v = rand.generate( 10, 2.0, 5.0 ); - * // returns - */ - ( prng: BinaryPRNG, dtypes: ArrayLike, dtype: DataType ): RandomArray; -} - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @param prng - binary pseudorandom value generator -* @param dtypes - list of supported output data types -* @param dtype - default output data type -* @returns instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new RandomArray( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -declare var ctor: RandomArrayConstructor; - - -// EXPORTS // - -export = ctor; - -// eslint-doctest-alias: RandomArray diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1eb0220..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 375539c..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 17e1023..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 73cf19be4569cbe9e5b02d3f455213525d3db675 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 23 Jun 2026 04:06:28 +0000 Subject: [PATCH 75/75] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 172 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 106 - benchmark/benchmark.generate.js | 102 - benchmark/benchmark.js | 94 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 94 - docs/types/test.ts | 250 - examples/index.js | 42 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 46 - lib/main.js | 192 - lib/validate.js | 68 - package.json | 70 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.js | 33 - 47 files changed, 4870 insertions(+), 4819 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.generate.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js delete mode 100644 lib/validate.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 03a6e2b..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-06-23T03:37:13.220Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index e4a1c86..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/random/array/tools/binary) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/contributing/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index c5ffe97..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/random/array/tools/binary) 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 5a4c3e6..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: '1 1 * * 2' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -213,7 +204,7 @@ x = random.generate( 10, 2.0, 5.0, { ## Notice -This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. +This package is part of [stdlib][stdlib], a standard library with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 637683f..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,106 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var zeros = require( '@stdlib/array-zeros' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float64' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, out ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:assign:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.generate.js b/benchmark/benchmark.generate.js deleted file mode 100644 index e35df8b..0000000 --- a/benchmark/benchmark.generate.js +++ /dev/null @@ -1,102 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveInteger} len - array length -* @returns {Function} benchmark function -*/ -function createBenchmark( len ) { - var random; - var dt; - - dt = dtypes( 'real_floating_point' ); - random = new Random( arcsine, dt, 'float64' ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var o; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.generate( len, 2.0, 5.0 ); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnan( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var len; - var min; - var max; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - len = pow( 10, i ); - f = createBenchmark( len ); - bench( format( '%s:generate:len=%d', pkg, len ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index f6b6894..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,94 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 arcsine = require( '@stdlib/random-base-arcsine' ); -var normal = require( '@stdlib/random-base-normal' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var Random = require( './../lib' ); - - -// MAIN // - -bench( format( '%s::new', pkg ), function benchmark( b ) { - var values; - var dtypes; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = new Random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( format( '%s::no_new', pkg ), function benchmark( b ) { - var values; - var dtypes; - var random; - var v; - var i; - - values = [ - arcsine, - normal - ]; - dtypes = [ - 'float64', - 'float32' - ]; - - random = Random; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = random( values[ i%values.length ], dtypes, 'float64' ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an object' ); - } - } - b.toc(); - if ( !( v instanceof Random ) ) { - b.fail( 'should return an instance' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 644d34c..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/random/array/tools/binary" -%% click B href "https://github.com/stdlib-js/random-array-tools-binary/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-tools-binary/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-tools-binary/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-tools-binary/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-tools-binary/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/tools/binary -[production-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-tools-binary/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-tools-binary/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-tools-binary/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 0b44231..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import ctor from '../docs/types/index'; -export = ctor; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 2cd07e5..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var m=function(i,r){return function(){try{return r||i((r={exports:{}}).exports,r),r.exports}catch(e){throw (r=0, e)}};};var c=m(function(B,p){ -var T=require('@stdlib/assert-is-plain-object/dist'),E=require('@stdlib/assert-has-own-property/dist'),_=require('@stdlib/array-base-assert-contains/dist'),l=require('@stdlib/error-tools-fmtprodmsg/dist');function V(i,r,e){return T(e)?E(e,"dtype")&&(i.dtype=e.dtype,!_(r,i.dtype))?new TypeError(l('1qj4S',"dtype",r.join('", "'),i.dtype)):null:new TypeError(l('1qj2V',e));}p.exports=V -});var w=m(function(C,y){ -var d=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=require('@stdlib/assert-is-nonnegative-integer/dist').isPrimitive,j=require('@stdlib/assert-is-function/dist'),x=require('@stdlib/assert-is-string-array/dist').primitives,F=require('@stdlib/assert-is-collection/dist'),N=require('@stdlib/array-base-assert-contains/dist'),P=require('@stdlib/array-base-filled-by/dist'),h=require('@stdlib/strided-base-binary/dist'),R=require('@stdlib/array-ctors/dist'),n=require('@stdlib/error-tools-fmtprodmsg/dist'),S=c();function a(i,r,e){if(!(this instanceof a))return new a(i,r,e);if(!j(i))throw new TypeError(n('1qj3c',i));if(!x(r))throw new TypeError(n('1qjAS',r));if(!N(r,e))throw new TypeError(n('1qjFO',e));return this._prng=i,this._dtypes=r,this._dtype=e,this}d(a.prototype,"generate",function(r,e,t,q){var f,u,s,o,v,g;if(!O(r))throw new TypeError(n('1qj2d',r));if(u={},arguments.length>3&&(v=S(u,this._dtypes,q),v))throw v;if(s=this._prng,g=u.dtype||this._dtype,g==="generic")return P(r,b);return f=R(g),o=new f(r),h([[e],[t],o],[r],[0,0,1],s),o;function b(){return s(e,t)}});d(a.prototype,"assign",function(r,e,t){if(!F(t))throw new TypeError(n('1qj2l',t));return h([[r],[e],t],[t.length],[0,0,1],this._prng),t});y.exports=a -});var k=w();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 b209dac..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../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// 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' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, 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, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be one of the following: \"%s\". Option: `%s`.', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive;\nvar isFunction = require( '@stdlib/assert-is-function' );\nvar isStringArray = require( '@stdlib/assert-is-string-array' ).primitives;\nvar isCollection = require( '@stdlib/assert-is-collection' );\nvar contains = require( '@stdlib/array-base-assert-contains' );\nvar filledBy = require( '@stdlib/array-base-filled-by' );\nvar binary = require( '@stdlib/strided-base-binary' );\nvar ctors = require( '@stdlib/array-ctors' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a function. Value: `%s`.', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be an array of strings. Value: `%s`.', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be a supported data type. Value: `%s`.', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a nonnegative integer. Value: `%s`.', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var zeros = require( '@stdlib/array-zeros' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an array-like object. Value: `%s`.', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nmodule.exports = Random;\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* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @module @stdlib/random-array-tools-binary\n*\n* @example\n* var arcsine = require( '@stdlib/random-base-arcsine' );\n* var Random = require( '@stdlib/random-array-tools-binary' );\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAW,QAAS,oCAAqC,EACzDC,EAAS,QAAS,uBAAwB,EA0B9C,SAASC,EAAUC,EAAMC,EAAQC,EAAU,CAC1C,OAAMP,EAAUO,CAAQ,EAGnBN,EAAYM,EAAS,OAAQ,IACjCF,EAAK,MAAQE,EAAQ,MAChB,CAACL,EAAUI,EAAQD,EAAK,KAAM,GAC3B,IAAI,UAAWF,EAAQ,gFAAiF,QAASG,EAAO,KAAM,MAAO,EAAGD,EAAK,KAAM,CAAE,EAGvJ,KARC,IAAI,UAAWF,EAAQ,qEAAsEI,CAAQ,CAAE,CAShH,CAKAR,EAAO,QAAUK,ICnEjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAuB,QAAS,uCAAwC,EAAE,YAC1EC,EAAa,QAAS,4BAA6B,EACnDC,EAAgB,QAAS,gCAAiC,EAAE,WAC5DC,EAAe,QAAS,8BAA+B,EACvDC,EAAW,QAAS,oCAAqC,EACzDC,EAAW,QAAS,8BAA+B,EACnDC,EAAS,QAAS,6BAA8B,EAChDC,EAAQ,QAAS,qBAAsB,EACvCC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IA4Bf,SAASC,EAAQC,EAAMC,EAAQC,EAAQ,CACtC,GAAK,EAAG,gBAAgBH,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,CAAM,EAExC,GAAK,CAACZ,EAAYU,CAAK,EACtB,MAAM,IAAI,UAAWH,EAAQ,oEAAqEG,CAAK,CAAE,EAG1G,GAAK,CAACT,EAAeU,CAAO,EAC3B,MAAM,IAAI,UAAWJ,EAAQ,8EAA+EI,CAAO,CAAE,EAGtH,GAAK,CAACR,EAAUQ,EAAQC,CAAM,EAC7B,MAAM,IAAI,UAAWL,EAAQ,+EAAgFK,CAAM,CAAE,EAEtH,YAAK,MAAQF,EACb,KAAK,QAAUC,EACf,KAAK,OAASC,EACP,IACR,CA6BAd,EAAaW,EAAO,UAAW,WAAY,SAAmBI,EAAKC,EAAQC,EAAQC,EAAU,CAC5F,IAAIC,EACAC,EACAR,EACAS,EACAC,EACAC,EACJ,GAAK,CAACtB,EAAsBc,CAAI,EAC/B,MAAM,IAAI,UAAWN,EAAQ,+EAAgFM,CAAI,CAAE,EAGpH,GADAK,EAAO,CAAC,EACH,UAAU,OAAS,IACvBE,EAAMZ,EAAUU,EAAM,KAAK,QAASF,CAAQ,EACvCI,GACJ,MAAMA,EAMR,GAFAV,EAAO,KAAK,MACZW,EAAKH,EAAK,OAAS,KAAK,OACnBG,IAAO,UACX,OAAOjB,EAAUS,EAAKS,CAAQ,EAE/B,OAAAL,EAAOX,EAAOe,CAAG,EACjBF,EAAM,IAAIF,EAAMJ,CAAI,EACpBR,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEN,CAAI,EAAG,CAAE,EAAG,EAAG,CAAE,EAAGH,CAAK,EAC7DS,EAQP,SAASG,GAAU,CAClB,OAAOZ,EAAMI,EAAQC,CAAO,CAC7B,CACD,CAAC,EAgCDjB,EAAaW,EAAO,UAAW,SAAU,SAAiBK,EAAQC,EAAQI,EAAM,CAC/E,GAAK,CAACjB,EAAciB,CAAI,EACvB,MAAM,IAAI,UAAWZ,EAAQ,8EAA+EY,CAAI,CAAE,EAGnH,OAAAd,EAAQ,CAAE,CAAES,CAAO,EAAG,CAAEC,CAAO,EAAGI,CAAI,EAAG,CAAEA,EAAI,MAAO,EAAG,CAAE,EAAG,EAAG,CAAE,EAAG,KAAK,KAAM,EAC1EA,CACR,CAAC,EAKDtB,EAAO,QAAUY,ICvJjB,IAAIc,EAAO,IAKX,OAAO,QAAUA", - "names": ["require_validate", "__commonJSMin", "exports", "module", "isObject", "hasOwnProp", "contains", "format", "validate", "opts", "dtypes", "options", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "isNonNegativeInteger", "isFunction", "isStringArray", "isCollection", "contains", "filledBy", "binary", "ctors", "format", "validate", "Random", "prng", "dtypes", "dtype", "len", "param1", "param2", "options", "ctor", "opts", "out", "err", "dt", "wrapper", "main"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5db2dc2..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,94 +0,0 @@ - -{{alias}}( prng, dtypes, dtype ) - Constructor for creating arrays filled with pseudorandom values drawn from - a binary PRNG. - - Parameters - ---------- - prng: Function - Binary pseudorandom value generator. - - dtypes: Array - List of supported output array data types. - - dtype: string - Default output array data type. - - Returns - ------- - out: Object - Instance having methods for creating filled arrays. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var out = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - - -{{alias}}.prototype.generate( len, param1, param2[, options] ) - Returns an array filled with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - len: integer - Output array length. - - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - options: Object (optional) - Function options. - - options.dtype: string (optional) - Output array data type. Setting this option overrides the default output - array data type. - - Returns - ------- - out: Array|TypedArray - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var v = r.generate( 5, 2.0, 5.0 ) - - - -{{alias}}.prototype.assign( param1, param2, out ) - Fills an array with pseudorandom values drawn from a binary PRNG. - - Parameters - ---------- - param1: any - First PRNG parameter. - - param2: any - Second PRNG parameter. - - out: Array|TypedArray|Object - Output array. - - Returns - ------- - out: Array|TypedArray|Object - Output array. - - Examples - -------- - > var dt = [ 'float64', 'float32', 'generic' ]; - > var r = {{alias}}( {{alias:@stdlib/random/base/arcsine}}, dt, 'float64' ); - > var out = {{alias:@stdlib/array/zeros}}( 5, 'float64' ) - - > var v = r.assign( 2.0, 5.0, out ) - - > var bool = ( out === v ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 7646ab1..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,250 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable @typescript-eslint/no-unused-expressions */ - -/// - -import { DataType } from '@stdlib/types/array'; -import arcsine = require( '@stdlib/random-base-arcsine' ); -import zeros = require( '@stdlib/array-zeros' ); -import Random = require( './index' ); - - -// TESTS // - -// The function returns an instance for generating arrays of pseudorandom values... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray - - const random = Random; - random( arcsine, dtypes, dtypes[ 0 ] ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a PRNG function... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - new Random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( '5', dtypes, dtypes[ 0 ] ); // $ExpectError - random( 5, dtypes, dtypes[ 0 ] ); // $ExpectError - random( true, dtypes, dtypes[ 0 ] ); // $ExpectError - random( false, dtypes, dtypes[ 0 ] ); // $ExpectError - random( null, dtypes, dtypes[ 0 ] ); // $ExpectError - random( void 0, dtypes, dtypes[ 0 ] ); // $ExpectError - random( 'abc', dtypes, dtypes[ 0 ] ); // $ExpectError - random( {}, dtypes, dtypes[ 0 ] ); // $ExpectError - random( ( x: number ): number => x, dtypes, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a list of data types... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - new Random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError - - const random = Random; - random( arcsine, '5', dtypes[ 0 ] ); // $ExpectError - random( arcsine, 5, dtypes[ 0 ] ); // $ExpectError - random( arcsine, true, dtypes[ 0 ] ); // $ExpectError - random( arcsine, false, dtypes[ 0 ] ); // $ExpectError - random( arcsine, null, dtypes[ 0 ] ); // $ExpectError - random( arcsine, void 0, dtypes[ 0 ] ); // $ExpectError - random( arcsine, 'abc', dtypes[ 0 ] ); // $ExpectError - random( arcsine, {}, dtypes[ 0 ] ); // $ExpectError - random( arcsine, ( x: number ): number => x, dtypes[ 0 ] ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a data type... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random( arcsine, dtypes, '5' ); // $ExpectError - new Random( arcsine, dtypes, 5 ); // $ExpectError - new Random( arcsine, dtypes, true ); // $ExpectError - new Random( arcsine, dtypes, false ); // $ExpectError - new Random( arcsine, dtypes, null ); // $ExpectError - new Random( arcsine, dtypes, void 0 ); // $ExpectError - new Random( arcsine, dtypes, 'abc' ); // $ExpectError - new Random( arcsine, dtypes, {} ); // $ExpectError - new Random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError - - const random = Random; - random( arcsine, dtypes, '5' ); // $ExpectError - random( arcsine, dtypes, 5 ); // $ExpectError - random( arcsine, dtypes, true ); // $ExpectError - random( arcsine, dtypes, false ); // $ExpectError - random( arcsine, dtypes, null ); // $ExpectError - random( arcsine, dtypes, void 0 ); // $ExpectError - random( arcsine, dtypes, 'abc' ); // $ExpectError - random( arcsine, dtypes, {} ); // $ExpectError - random( arcsine, dtypes, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - new Random(); // $ExpectError - new Random( arcsine ); // $ExpectError - new Random( arcsine, dtypes ); // $ExpectError - new Random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError - - const random = Random; - random(); // $ExpectError - random( arcsine ); // $ExpectError - random( arcsine, dtypes ); // $ExpectError - random( arcsine, dtypes, dtypes[ 0 ], {} ); // $ExpectError -} - -// The function returns an instance having a `generate` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r1.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.generate( 10, 2.0, 5.0 ); // $ExpectType OutputArray - r2.generate( 10, 2.0, 5.0, {} ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `generate` method is provided a first argument which is not a number... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( '5', 2.0, 5.0 ); // $ExpectError - r1.generate( true, 2.0, 5.0 ); // $ExpectError - r1.generate( false, 2.0, 5.0 ); // $ExpectError - r1.generate( null, 2.0, 5.0 ); // $ExpectError - r1.generate( void 0, 2.0, 5.0 ); // $ExpectError - r1.generate( [], 2.0, 5.0 ); // $ExpectError - r1.generate( {}, 2.0, 5.0 ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0 ); // $ExpectError - - r1.generate( '5', 2.0, 5.0, {} ); // $ExpectError - r1.generate( true, 2.0, 5.0, {} ); // $ExpectError - r1.generate( false, 2.0, 5.0, {} ); // $ExpectError - r1.generate( null, 2.0, 5.0, {} ); // $ExpectError - r1.generate( void 0, 2.0, 5.0, {} ); // $ExpectError - r1.generate( [], 2.0, 5.0, {} ); // $ExpectError - r1.generate( {}, 2.0, 5.0, {} ); // $ExpectError - r1.generate( ( x: number ): number => x, 2.0, 5.0, {} ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided a fourth argument which is not an object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, '5' ); // $ExpectError - r1.generate( 10, 2.0, 5.0, true ); // $ExpectError - r1.generate( 10, 2.0, 5.0, false ); // $ExpectError - r1.generate( 10, 2.0, 5.0, null ); // $ExpectError - r1.generate( 10, 2.0, 5.0, [] ); // $ExpectError - r1.generate( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an invalid `dtype` option... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate( 10, 2.0, 5.0, { 'dtype': '5' } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': 5 } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': true } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': false } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': null } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': [] } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': {} } ); // $ExpectError - r1.generate( 10, 2.0, 5.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `generate` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.generate(); // $ExpectError - r1.generate( 10 ); // $ExpectError - r1.generate( 10, 2.0 ); // $ExpectError - r1.generate( 10, 2.0, 5.0, {}, {} ); // $ExpectError -} - -// The function returns an instance having an `assign` method which returns an array... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, x ); // $ExpectType OutputArray - - const random = Random; - const r2 = random( arcsine, dtypes, dtypes[ 0 ] ); - r2.assign( 2.0, 5.0, x ); // $ExpectType OutputArray -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array-like object... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign( 2.0, 5.0, '5' ); // $ExpectError - r1.assign( 2.0, 5.0, 5 ); // $ExpectError - r1.assign( 2.0, 5.0, true ); // $ExpectError - r1.assign( 2.0, 5.0, false ); // $ExpectError - r1.assign( 2.0, 5.0, null ); // $ExpectError - r1.assign( 2.0, 5.0, void 0 ); // $ExpectError - r1.assign( 2.0, 5.0, {} ); // $ExpectError - r1.assign( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const dtypes: Array = [ 'float64', 'float32' ]; - const x = zeros( 10, 'float64' ); - - const r1 = new Random( arcsine, dtypes, dtypes[ 0 ] ); - r1.assign(); // $ExpectError - r1.assign( 2.0 ); // $ExpectError - r1.assign( 2.0, 5.0 ); // $ExpectError - r1.assign( 2.0, 5.0, x, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index de508c9..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 arcsine = require( '@stdlib/random-base-arcsine' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var Random = require( './../lib' ); - -var dt = dtypes( 'real_floating_point_and_generic' ); -var random = new Random( arcsine, dt, 'float64' ); - -var x = random.generate( 10, 2.0, 5.0 ); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'float32' -}); -console.log( x ); -// => - -x = random.generate( 10, 2.0, 5.0, { - 'dtype': 'generic' -}); -console.log( x ); -// => [...] 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 0a18af9..5eb0681 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { DataType, ArrayLike, AccessorArrayLike } from '@stdlib/types/array'; import { PRNG } from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1eb0220 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import t from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";import{isPrimitive as e}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-nonnegative-integer@v0.2.3-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-function@v0.2.3-esm/index.mjs";import{primitives as r}from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-string-array@v0.2.3-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-collection@v0.2.3-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-assert-contains@v0.2.3-esm/index.mjs";import d from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled-by@v0.2.3-esm/index.mjs";import o from"https://cdn.jsdelivr.net/gh/stdlib-js/strided-base-binary@v0.3.1-esm/index.mjs";import p from"https://cdn.jsdelivr.net/gh/stdlib-js/array-ctors@v0.3.1-esm/index.mjs";import m from"https://cdn.jsdelivr.net/gh/stdlib-js/error-tools-fmtprodmsg@v0.2.3-esm/index.mjs";import j from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-is-plain-object@v0.2.3-esm/index.mjs";import h from"https://cdn.jsdelivr.net/gh/stdlib-js/assert-has-own-property@v0.2.3-esm/index.mjs";function l(t,e,n){if(!(this instanceof l))return new l(t,e,n);if(!s(t))throw new TypeError(m("1qj3c",t));if(!r(e))throw new TypeError(m("1qjAS",e));if(!i(e,n))throw new TypeError(m("1qjFO",n));return this._prng=t,this._dtypes=e,this._dtype=n,this}t(l.prototype,"generate",(function(t,s,r,n){var l,a,f,y,c;if(!e(t))throw new TypeError(m("1qj2d",t));if(l={},arguments.length>3&&(y=function(t,e,s){return j(s)?h(s,"dtype")&&(t.dtype=s.dtype,!i(e,t.dtype))?new TypeError(m("1qj4S","dtype",e.join('", "'),t.dtype)):null:new TypeError(m("1qj2V",s))}(l,this._dtypes,n),y))throw y;return a=this._prng,"generic"===(c=l.dtype||this._dtype)?d(t,(function(){return a(s,r)})):(f=new(p(c))(t),o([[s],[r],f],[t],[0,0,1],a),f)})),t(l.prototype,"assign",(function(t,e,s){if(!n(s))throw new TypeError(m("1qj2l",s));return o([[t],[e],s],[s.length],[0,0,1],this._prng),s}));export{l as default}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..375539c --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/main.js","../lib/validate.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/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport { isPrimitive as isNonNegativeInteger } from '@stdlib/assert-is-nonnegative-integer';\nimport isFunction from '@stdlib/assert-is-function';\nimport { primitives as isStringArray } from '@stdlib/assert-is-string-array';\nimport isCollection from '@stdlib/assert-is-collection';\nimport contains from '@stdlib/array-base-assert-contains';\nimport filledBy from '@stdlib/array-base-filled-by';\nimport binary from '@stdlib/strided-base-binary';\nimport ctors from '@stdlib/array-ctors';\nimport format from '@stdlib/error-tools-fmtprodmsg';\nimport validate from './validate.js';\n\n\n// MAIN //\n\n/**\n* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.\n*\n* @constructor\n* @param {Function} prng - binary pseudorandom value generator\n* @param {StringArray} dtypes - list of supported output data types\n* @param {string} dtype - default output data type\n* @throws {TypeError} first argument must be a function\n* @throws {TypeError} second argument must be an array of strings\n* @throws {TypeError} third argument must be a supported data type\n* @returns {Random} instance\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nfunction Random( prng, dtypes, dtype ) {\n\tif ( !( this instanceof Random ) ) {\n\t\treturn new Random( prng, dtypes, dtype );\n\t}\n\tif ( !isFunction( prng ) ) {\n\t\tthrow new TypeError( format( '1qj3c', prng ) );\n\t}\n\t// TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings\n\tif ( !isStringArray( dtypes ) ) {\n\t\tthrow new TypeError( format( '1qjAS', dtypes ) );\n\t}\n\t// Require that the default output array data type be a member of the list of supported output array data types...\n\tif ( !contains( dtypes, dtype ) ) {\n\t\tthrow new TypeError( format( '1qjFO', dtype ) );\n\t}\n\tthis._prng = prng;\n\tthis._dtypes = dtypes;\n\tthis._dtype = dtype;\n\treturn this;\n}\n\n/**\n* Returns an array filled with pseudorandom values drawn from a binary PRNG.\n*\n* @name generate\n* @memberof Random.prototype\n* @type {Function}\n* @param {NonNegativeInteger} len - number of elements\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Options} [options] - function options\n* @param {string} [options.dtype] - array data type\n* @throws {TypeError} first argument must be a nonnegative integer\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var v = rand.generate( 10, 2.0, 5.0 );\n* // returns \n*/\nsetReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) {\n\tvar ctor;\n\tvar opts;\n\tvar prng;\n\tvar out;\n\tvar err;\n\tvar dt;\n\tif ( !isNonNegativeInteger( len ) ) {\n\t\tthrow new TypeError( format( '1qj2d', len ) );\n\t}\n\topts = {};\n\tif ( arguments.length > 3 ) {\n\t\terr = validate( opts, this._dtypes, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tprng = this._prng;\n\tdt = opts.dtype || this._dtype;\n\tif ( dt === 'generic' ) {\n\t\treturn filledBy( len, wrapper );\n\t}\n\tctor = ctors( dt );\n\tout = new ctor( len );\n\tbinary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng );\n\treturn out;\n\n\t/**\n\t* Applies parameters to a pseudorandom value generator function.\n\t*\n\t* @private\n\t* @returns {*} pseudorandom value\n\t*/\n\tfunction wrapper() {\n\t\treturn prng( param1, param2 );\n\t}\n});\n\n/**\n* Fills an array with pseudorandom values drawn from a binary PRNG.\n*\n* @name assign\n* @memberof Random.prototype\n* @type {Function}\n* @param {*} param1 - first PRNG parameter\n* @param {*} param2 - second PRNG parameter\n* @param {Collection} out - output array\n* @throws {TypeError} third argument must be a collection\n* @returns {Collection} output array\n*\n* @example\n* import arcsine from '@stdlib/random-base-arcsine';\n* import zeros from '@stdlib/array-zeros';\n*\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var defaultDType = 'float64';\n*\n* var rand = new Random( arcsine, dtypes, defaultDType );\n*\n* var out = zeros( 10, 'float64' );\n* // returns \n*\n* var v = rand.assign( 2.0, 5.0, out );\n* // returns \n*\n* var bool = ( v === out );\n* // returns true\n*/\nsetReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) {\n\tif ( !isCollection( out ) ) {\n\t\tthrow new TypeError( format( '1qj2l', out ) );\n\t}\n\t// NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array).\n\tbinary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len\n\treturn out;\n});\n\n\n// EXPORTS //\n\nexport default Random;\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 isObject from '@stdlib/assert-is-plain-object';\nimport hasOwnProp from '@stdlib/assert-has-own-property';\nimport contains from '@stdlib/array-base-assert-contains';\nimport format from '@stdlib/error-tools-fmtprodmsg';\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination object\n* @param {Array} dtypes - list of supported output data types\n* @param {Options} options - function options\n* @param {string} [options.dtype] - output array data type\n* @returns {(Error|null)} null or an error object\n*\n* @example\n* var opts = {};\n* var dtypes = [ 'float64', 'float32', 'generic' ];\n* var options = {\n* 'dtype': 'float64'\n* };\n* var err = validate( opts, dtypes, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, dtypes, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( '1qj2V', options ) );\n\t}\n\tif ( hasOwnProp( options, 'dtype' ) ) {\n\t\topts.dtype = options.dtype;\n\t\tif ( !contains( dtypes, opts.dtype ) ) {\n\t\t\treturn new TypeError( format( '1qj4S', 'dtype', dtypes.join( '\", \"' ), opts.dtype ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nexport default validate;\n"],"names":["Random","prng","dtypes","dtype","this","isFunction","TypeError","format","isStringArray","contains","_prng","_dtypes","_dtype","setReadOnly","prototype","len","param1","param2","options","opts","out","err","dt","isNonNegativeInteger","arguments","length","isObject","hasOwnProp","join","validate","filledBy","ctors","binary","isCollection"],"mappings":";;srCA8DA,SAASA,EAAQC,EAAMC,EAAQC,GAC9B,KAAQC,gBAAgBJ,GACvB,OAAO,IAAIA,EAAQC,EAAMC,EAAQC,GAElC,IAAME,EAAYJ,GACjB,MAAM,IAAIK,UAAWC,EAAQ,QAASN,IAGvC,IAAMO,EAAeN,GACpB,MAAM,IAAII,UAAWC,EAAQ,QAASL,IAGvC,IAAMO,EAAUP,EAAQC,GACvB,MAAM,IAAIG,UAAWC,EAAQ,QAASJ,IAKvC,OAHAC,KAAKM,MAAQT,EACbG,KAAKO,QAAUT,EACfE,KAAKQ,OAAST,EACPC,IACR,CA6BAS,EAAab,EAAOc,UAAW,YAAY,SAAmBC,EAAKC,EAAQC,EAAQC,GAClF,IACIC,EACAlB,EACAmB,EACAC,EACAC,EACJ,IAAMC,EAAsBR,GAC3B,MAAM,IAAIT,UAAWC,EAAQ,QAASQ,IAGvC,GADAI,EAAO,CAAA,EACFK,UAAUC,OAAS,IACvBJ,ECvEF,SAAmBF,EAAMjB,EAAQgB,GAChC,OAAMQ,EAAUR,GAGXS,EAAYT,EAAS,WACzBC,EAAKhB,MAAQe,EAAQf,OACfM,EAAUP,EAAQiB,EAAKhB,QACrB,IAAIG,UAAWC,EAAQ,QAAS,QAASL,EAAO0B,KAAM,QAAUT,EAAKhB,QAGvE,KARC,IAAIG,UAAWC,EAAQ,QAASW,GASzC,CD4DQW,CAAUV,EAAMf,KAAKO,QAASO,GAC/BG,GACJ,MAAMA,EAMR,OAFApB,EAAOG,KAAKM,MAEA,aADZY,EAAKH,EAAKhB,OAASC,KAAKQ,QAEhBkB,EAAUf,GAalB,WACC,OAAOd,EAAMe,EAAQC,EACrB,KAZDG,EAAM,IADCW,EAAOT,GACR,CAAUP,GAChBiB,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEL,GAAO,CAAE,EAAG,EAAG,GAAKd,GACxDmB,EAWR,IAgCAP,EAAab,EAAOc,UAAW,UAAU,SAAiBE,EAAQC,EAAQG,GACzE,IAAMa,EAAcb,GACnB,MAAM,IAAId,UAAWC,EAAQ,QAASa,IAIvC,OADAY,EAAQ,CAAE,CAAEhB,GAAU,CAAEC,GAAUG,GAAO,CAAEA,EAAIK,QAAU,CAAE,EAAG,EAAG,GAAKrB,KAAKM,OACpEU,CACR"} \ No newline at end of file diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 4aa9ee3..0000000 --- a/lib/index.js +++ /dev/null @@ -1,46 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @module @stdlib/random-array-tools-binary -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var Random = require( '@stdlib/random-array-tools-binary' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ - -// 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 44fc597..0000000 --- a/lib/main.js +++ /dev/null @@ -1,192 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable no-restricted-syntax, no-invalid-this */ - -'use strict'; - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var isNonNegativeInteger = require( '@stdlib/assert-is-nonnegative-integer' ).isPrimitive; -var isFunction = require( '@stdlib/assert-is-function' ); -var isStringArray = require( '@stdlib/assert-is-string-array' ).primitives; -var isCollection = require( '@stdlib/assert-is-collection' ); -var contains = require( '@stdlib/array-base-assert-contains' ); -var filledBy = require( '@stdlib/array-base-filled-by' ); -var binary = require( '@stdlib/strided-base-binary' ); -var ctors = require( '@stdlib/array-ctors' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); -var validate = require( './validate.js' ); - - -// MAIN // - -/** -* Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG. -* -* @constructor -* @param {Function} prng - binary pseudorandom value generator -* @param {StringArray} dtypes - list of supported output data types -* @param {string} dtype - default output data type -* @throws {TypeError} first argument must be a function -* @throws {TypeError} second argument must be an array of strings -* @throws {TypeError} third argument must be a supported data type -* @returns {Random} instance -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -function Random( prng, dtypes, dtype ) { - if ( !( this instanceof Random ) ) { - return new Random( prng, dtypes, dtype ); - } - if ( !isFunction( prng ) ) { - throw new TypeError( format( '1qj3c', prng ) ); - } - // TODO: tighten this up by actually validating that `dtypes` contains only recognized/supported dtype strings - if ( !isStringArray( dtypes ) ) { - throw new TypeError( format( '1qjAS', dtypes ) ); - } - // Require that the default output array data type be a member of the list of supported output array data types... - if ( !contains( dtypes, dtype ) ) { - throw new TypeError( format( '1qjFO', dtype ) ); - } - this._prng = prng; - this._dtypes = dtypes; - this._dtype = dtype; - return this; -} - -/** -* Returns an array filled with pseudorandom values drawn from a binary PRNG. -* -* @name generate -* @memberof Random.prototype -* @type {Function} -* @param {NonNegativeInteger} len - number of elements -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Options} [options] - function options -* @param {string} [options.dtype] - array data type -* @throws {TypeError} first argument must be a nonnegative integer -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var v = rand.generate( 10, 2.0, 5.0 ); -* // returns -*/ -setReadOnly( Random.prototype, 'generate', function generate( len, param1, param2, options ) { - var ctor; - var opts; - var prng; - var out; - var err; - var dt; - if ( !isNonNegativeInteger( len ) ) { - throw new TypeError( format( '1qj2d', len ) ); - } - opts = {}; - if ( arguments.length > 3 ) { - err = validate( opts, this._dtypes, options ); - if ( err ) { - throw err; - } - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when generating small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - prng = this._prng; - dt = opts.dtype || this._dtype; - if ( dt === 'generic' ) { - return filledBy( len, wrapper ); - } - ctor = ctors( dt ); - out = new ctor( len ); - binary( [ [ param1 ], [ param2 ], out ], [ len ], [ 0, 0, 1 ], prng ); - return out; - - /** - * Applies parameters to a pseudorandom value generator function. - * - * @private - * @returns {*} pseudorandom value - */ - function wrapper() { - return prng( param1, param2 ); - } -}); - -/** -* Fills an array with pseudorandom values drawn from a binary PRNG. -* -* @name assign -* @memberof Random.prototype -* @type {Function} -* @param {*} param1 - first PRNG parameter -* @param {*} param2 - second PRNG parameter -* @param {Collection} out - output array -* @throws {TypeError} third argument must be a collection -* @returns {Collection} output array -* -* @example -* var arcsine = require( '@stdlib/random-base-arcsine' ); -* var zeros = require( '@stdlib/array-zeros' ); -* -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var defaultDType = 'float64'; -* -* var rand = new Random( arcsine, dtypes, defaultDType ); -* -* var out = zeros( 10, 'float64' ); -* // returns -* -* var v = rand.assign( 2.0, 5.0, out ); -* // returns -* -* var bool = ( v === out ); -* // returns true -*/ -setReadOnly( Random.prototype, 'assign', function assign( param1, param2, out ) { - if ( !isCollection( out ) ) { - throw new TypeError( format( '1qj2l', out ) ); - } - // NOTE: we could alternatively use the PRNG factory function to create a nullary PRNG function which applies parameters for each invocation; however, this would impose a one-time cost which is likely to be rather expensive when filling small arrays. The decision made here avoids this cost, despite a small cost due to repeatedly validating parameters for each generated pseudorandom value. Additionally, the current implementation has the added benefit that it mirrors the underlying PRNG where invalid parameters result in, e.g., a return value of `NaN` (however, realization of this benefit depends on the output array being a floating-point array). - binary( [ [ param1 ], [ param2 ], out ], [ out.length ], [ 0, 0, 1 ], this._prng ); // eslint-disable-line max-len - return out; -}); - - -// EXPORTS // - -module.exports = Random; diff --git a/lib/validate.js b/lib/validate.js deleted file mode 100644 index 4b4591b..0000000 --- a/lib/validate.js +++ /dev/null @@ -1,68 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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' ); -var format = require( '@stdlib/error-tools-fmtprodmsg' ); - - -// MAIN // - -/** -* Validates function options. -* -* @private -* @param {Object} opts - destination object -* @param {Array} dtypes - list of supported output data types -* @param {Options} options - function options -* @param {string} [options.dtype] - output array data type -* @returns {(Error|null)} null or an error object -* -* @example -* var opts = {}; -* var dtypes = [ 'float64', 'float32', 'generic' ]; -* var options = { -* 'dtype': 'float64' -* }; -* var err = validate( opts, dtypes, options ); -* if ( err ) { -* throw err; -* } -*/ -function validate( opts, dtypes, options ) { - if ( !isObject( options ) ) { - return new TypeError( format( '1qj2V', options ) ); - } - if ( hasOwnProp( options, 'dtype' ) ) { - opts.dtype = options.dtype; - if ( !contains( dtypes, opts.dtype ) ) { - return new TypeError( format( '1qj4S', 'dtype', dtypes.join( '", "' ), opts.dtype ) ); - } - } - return null; -} - - -// EXPORTS // - -module.exports = validate; diff --git a/package.json b/package.json index 231ec16..1c3ddd9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Constructor for creating arrays filled with pseudorandom values drawn from a binary PRNG.", "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,49 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-assert-contains": "^0.2.3", - "@stdlib/array-base-filled-by": "^0.2.3", - "@stdlib/array-ctors": "^0.3.1", - "@stdlib/assert-has-own-property": "^0.2.3", - "@stdlib/assert-is-collection": "^0.2.3", - "@stdlib/assert-is-function": "^0.2.3", - "@stdlib/assert-is-nonnegative-integer": "^0.2.3", - "@stdlib/assert-is-plain-object": "^0.2.3", - "@stdlib/assert-is-string-array": "^0.2.3", - "@stdlib/strided-base-binary": "^0.3.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/types": "^0.5.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-dtypes": "^0.4.1", - "@stdlib/array-zeros": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/random-base-arcsine": "^0.2.2", - "@stdlib/random-base-normal": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "stdmath", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..17e1023 --- /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 e346d56..0000000 --- a/test/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var Random = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof Random, 'function', 'main export is a function' ); - t.end(); -});