From 02dd86ffd783f4899d7773e7c30eb375394a0315 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Jan 2024 05:56:57 +0000 Subject: [PATCH 01/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 6f1703c..85e9e5e 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "github:stdlib-js/random-array-tools-ternary-factory#main", "@stdlib/random-base-triangular": "^0.1.0", "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-float32": "^0.1.1", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6740239fe6255efd6bddf59782c88498b1cf6223 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 13 Jan 2024 06:02:45 +0000 Subject: [PATCH 02/41] 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 | 63 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 54 files changed, 6217 insertions(+), 6957 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 bde376f..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA 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 + + ```
@@ -400,7 +399,7 @@ logEach( '%f', x4 ); ## 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]. @@ -460,13 +459,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 46badf9..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cb3bee7 --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.1.0-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..5ae9f45 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;+eA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 85e9e5e..409b18a 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/random-array-tools-ternary-factory": "github:stdlib-js/random-array-tools-ternary-factory#main", - "@stdlib/random-base-triangular": "^0.1.0", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-nans": "^0.1.0", - "@stdlib/array-uint32": "^0.1.1", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/console-log-each": "^0.1.0", - "@stdlib/constants-uint32-max": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-assert-is-nanf": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..65ac30b --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 5950209431bc37176017559fcb78756735f902e2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 16 Jan 2024 15:04:37 +0000 Subject: [PATCH 03/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 0a4b112..1f28c9b 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.1.0", "@stdlib/random-base-triangular": "^0.1.0", "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-float32": "^0.1.1", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a00d718cd88c3f2680aad0dd309d64e57ac684ea Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 16 Jan 2024 15:05:03 +0000 Subject: [PATCH 04/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6467 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cb3bee7..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.1.0-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 5ae9f45..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;+eA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 65ac30b..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f371628d2971254479eab0fad0ab5f5e080dc1f3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 16 Jan 2024 15:05:40 +0000 Subject: [PATCH 05/41] 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 | 63 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 54 files changed, 6217 insertions(+), 6957 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 bde376f..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA 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 + + ```
@@ -400,7 +399,7 @@ logEach( '%f', x4 ); ## 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]. @@ -460,13 +459,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 46badf9..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cb3bee7 --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.1.0-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..5ae9f45 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;+eA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 1f28c9b..25b8404 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/random-array-tools-ternary-factory": "^0.1.0", - "@stdlib/random-base-triangular": "^0.1.0", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-nans": "^0.1.0", - "@stdlib/array-uint32": "^0.1.1", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/console-log-each": "^0.1.0", - "@stdlib/constants-uint32-max": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-assert-is-nanf": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..4163fdb --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 96991d4e071fbc598c850b23a7392a3ed655fd5a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 16 Jan 2024 15:06:02 +0000 Subject: [PATCH 06/41] Update README.md for ESM bundle v0.1.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index cc72be6..a4d71f8 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import triangular from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@esm/index.mjs'; +import triangular from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@v0.1.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@esm/index.mjs'; +import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@v0.1.0-esm/index.mjs'; ``` #### triangular( len, a, b, c\[, options] ) @@ -345,7 +345,7 @@ var sz = random.byteLength; - - - - From 2a01fae4501979d22c3c48e9735654fce4bd7ec5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 21 Jan 2024 05:51:57 +0000 Subject: [PATCH 10/41] 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 | 63 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 54 files changed, 6217 insertions(+), 6957 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 bde376f..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA 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 + + ```
@@ -406,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -466,13 +465,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 46badf9..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[esm-url]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..cb3bee7 --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.1.0-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..5ae9f45 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;+eA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 1f28c9b..25b8404 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.1.0", - "@stdlib/array-dtypes": "^0.1.0", - "@stdlib/random-array-tools-ternary-factory": "^0.1.0", - "@stdlib/random-base-triangular": "^0.1.0", - "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.1.1", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/array-nans": "^0.1.0", - "@stdlib/array-uint32": "^0.1.1", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.1.1", - "@stdlib/console-log-each": "^0.1.0", - "@stdlib/constants-uint32-max": "^0.1.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-assert-is-nanf": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..abfcbda --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 995fa5e5c83f12a91aa8dc39aeb451c141b82b15 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 01:35:15 +0000 Subject: [PATCH 11/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9f695c5..939b41e 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.2.0", "@stdlib/random-base-triangular": "^0.2.0", "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-float32": "^0.2.0", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From fc728b4d2c81f4f847552ec5bddc45530e50d986 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 05:09:09 +0000 Subject: [PATCH 12/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6467 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index cb3bee7..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.1.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.1.0-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 5ae9f45..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;+eA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index abfcbda..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b74f6184ff4756082d3263c259d890cc1acd8680 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 05:10:26 +0000 Subject: [PATCH 13/41] 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 | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 54 files changed, 6217 insertions(+), 6966 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 9c69762..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA 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 + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..877523a --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.1.0-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..5ae9f45 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;+eA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 939b41e..d578db0 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.2.0", - "@stdlib/array-dtypes": "^0.2.0", - "@stdlib/random-array-tools-ternary-factory": "^0.2.0", - "@stdlib/random-base-triangular": "^0.2.0", - "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-float32": "^0.2.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/array-nans": "^0.2.0", - "@stdlib/array-uint32": "^0.2.0", - "@stdlib/array-zeros": "^0.1.0", - "@stdlib/assert-is-uint32array": "^0.2.0", - "@stdlib/console-log-each": "^0.1.0", - "@stdlib/constants-uint32-max": "^0.2.0", - "@stdlib/math-base-assert-is-nan": "^0.2.0", - "@stdlib/math-base-assert-is-nanf": "^0.2.0", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f219890 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 60f0a86901bae1ee518de8d651e764198c435f53 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:41:29 +0000 Subject: [PATCH 14/41] Update README.md for ESM bundle v0.2.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 490c219..d72c27c 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import triangular from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@esm/index.mjs'; +import triangular from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@v0.2.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@esm/index.mjs'; +import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@v0.2.0-esm/index.mjs'; ``` #### triangular( len, a, b, c\[, options] ) @@ -345,7 +345,7 @@ var sz = random.byteLength; - - - - From 4cb5b4bd2623d219ab0c4d3e005fb24603a2f021 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:40:38 +0000 Subject: [PATCH 18/41] 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 | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ------ test/test.js | 74 - test/test.main.js | 244 -- 54 files changed, 4882 insertions(+), 6960 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..b536acd --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.0-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index eb62dfe..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/random-array-tools-ternary-factory": "^0.2.1", - "@stdlib/random-base-triangular": "^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-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-zeros": "^0.2.0", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/console-log-each": "^0.2.0", - "@stdlib/constants-uint32-max": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-assert-is-nanf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..57a10be --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From e1454a582a046a6b3d42faef1af4a7bc47609bd3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:17:49 +0000 Subject: [PATCH 19/41] Update README.md for ESM bundle v0.2.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7bebc9f..b6098f8 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import triangular from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@esm/index.mjs'; +import triangular from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@v0.2.1-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@esm/index.mjs'; +import { factory } from 'https://cdn.jsdelivr.net/gh/stdlib-js/random-array-triangular@v0.2.1-esm/index.mjs'; ``` #### triangular( len, a, b, c\[, options] ) @@ -345,7 +345,7 @@ var sz = random.byteLength; - - - - From ac670682733ee9b1ac39b50d6276d16ba831e111 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:21:05 +0000 Subject: [PATCH 23/41] 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 | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ------ test/test.js | 74 - test/test.main.js | 244 -- 55 files changed, 4882 insertions(+), 6962 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 8279a5f..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T06:13:38.721Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1bd2d3e --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index bf42204..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/random-array-tools-ternary-factory": "^0.2.1", - "@stdlib/random-base-triangular": "^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-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/console-log-each": "^0.2.1", - "@stdlib/constants-uint32-max": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-assert-is-nanf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..785da74 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 376281139194090082f3c098082bd48d28e156ea Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 07:52:57 +0000 Subject: [PATCH 24/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 95e1128..bf42204 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.2.1", "@stdlib/random-base-triangular": "^0.2.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-float32": "^0.2.1", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 18bc17f458adfd4765ea41a7f8ffafafebc61774 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:22:42 +0000 Subject: [PATCH 25/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5132 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1bd2d3e..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 53bb781..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 785da74..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 487aca2cf01366d78c7dd17ae5bde1331f460534 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:22:54 +0000 Subject: [PATCH 26/41] 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 | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ------ test/test.js | 74 - test/test.main.js | 244 -- 55 files changed, 4882 insertions(+), 6965 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 953e804..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:29:15.244Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1bd2d3e --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index bf42204..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/random-array-tools-ternary-factory": "^0.2.1", - "@stdlib/random-base-triangular": "^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-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/console-log-each": "^0.2.1", - "@stdlib/constants-uint32-max": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-assert-is-nanf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..785da74 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 268834e964376ecf4c6ade5b1d3150ed438be42c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 04:05:40 +0000 Subject: [PATCH 27/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 95e1128..bf42204 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.2.1", "@stdlib/random-base-triangular": "^0.2.1", "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-float32": "^0.2.1", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4e153e67d0d62fbcbccf97c53f55ddac28df202e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:39:09 +0000 Subject: [PATCH 28/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5132 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1bd2d3e..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 53bb781..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 785da74..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e540eaf71769b4f851e6cca2b2f32b20c7c11e80 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:39:29 +0000 Subject: [PATCH 29/41] 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 | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ------ test/test.js | 74 - test/test.main.js | 244 -- 54 files changed, 4882 insertions(+), 6966 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..1bd2d3e --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index bf42204..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.2.1", - "@stdlib/array-dtypes": "^0.2.1", - "@stdlib/random-array-tools-ternary-factory": "^0.2.1", - "@stdlib/random-base-triangular": "^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-float32": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.1", - "@stdlib/array-zeros": "^0.2.1", - "@stdlib/assert-is-uint32array": "^0.2.1", - "@stdlib/console-log-each": "^0.2.1", - "@stdlib/constants-uint32-max": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-assert-is-nanf": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..785da74 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 3991eb2fc799e9d991f5a5c7b77712b32775cafc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 03:32:16 +0000 Subject: [PATCH 30/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4defe6e..3297722 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.2.2", "@stdlib/random-base-triangular": "^0.2.1", "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-float32": "^0.2.2", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 017b83d1dbc346123f7ecb9021b00a3ab5324967 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 04:44:54 +0000 Subject: [PATCH 31/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5132 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 1bd2d3e..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.2.1-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 53bb781..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 785da74..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 3022a8f4e457f12ba8ae990414136c9dbbb5bd4f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 04:45:13 +0000 Subject: [PATCH 32/41] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 80 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 56 files changed, 4882 insertions(+), 7160 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0779e8a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 91cb6af..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-30T03:00:30.188Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 2e63cfc..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..11b28f3 --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.3.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 3297722..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/random-array-tools-ternary-factory": "^0.2.2", - "@stdlib/random-base-triangular": "^0.2.1", - "@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-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/console-log-each": "^0.2.2", - "@stdlib/constants-uint32-max": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-assert-is-nanf": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..e4b78fa --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From 16fa453575c966fa465e8732569a7324ef3b32d7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:33:53 +0000 Subject: [PATCH 33/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4defe6e..3297722 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.2.2", "@stdlib/random-base-triangular": "^0.2.1", "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-float32": "^0.2.2", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From b75e86debc5dad731e8567c94f326113864694f0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:43:04 +0000 Subject: [PATCH 34/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5132 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 11b28f3..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.3.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 53bb781..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e4b78fa..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 134653ecac0058e9b4ea2d9b33fdeda71aca10c0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:43:20 +0000 Subject: [PATCH 35/41] 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 | 80 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 56 files changed, 4882 insertions(+), 7163 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index d6fbfff..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-10T00:32:22.508Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7917a9c..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c65043e --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.3.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 3297722..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/random-array-tools-ternary-factory": "^0.2.2", - "@stdlib/random-base-triangular": "^0.2.1", - "@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-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/console-log-each": "^0.2.2", - "@stdlib/constants-uint32-max": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-assert-is-nanf": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..e4b78fa --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From a5c6c9dc7693d30b3e6f59d7866d0c6b8c93099e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Jun 2025 01:03:04 +0000 Subject: [PATCH 36/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4defe6e..3297722 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.2.2", "@stdlib/random-base-triangular": "^0.2.1", "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-float32": "^0.2.2", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6ccb9ba5f55a01bc5d2abdb1a23dc8d2b06378dc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Jun 2025 01:24:50 +0000 Subject: [PATCH 37/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5132 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c65043e..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.3.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 53bb781..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e4b78fa..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c14195626c1285057ce00b58efa6a2492f26521a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Jun 2025 01:25:08 +0000 Subject: [PATCH 38/41] 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 | 80 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 56 files changed, 4882 insertions(+), 7163 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 7660046..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-06-30T00:56:20.256Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7917a9c..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c65043e --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.3.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 3297722..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/random-array-tools-ternary-factory": "^0.2.2", - "@stdlib/random-base-triangular": "^0.2.1", - "@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-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/console-log-each": "^0.2.2", - "@stdlib/constants-uint32-max": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-assert-is-nanf": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..e4b78fa --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); From fa4793d973010818fce725b3ce4647514a4fa4f1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 21 Jul 2025 00:38:10 +0000 Subject: [PATCH 39/41] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4defe6e..3297722 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "@stdlib/random-array-tools-ternary-factory": "^0.2.2", "@stdlib/random-base-triangular": "^0.2.1", "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-float32": "^0.2.2", @@ -101,4 +102,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9a064f9cdf38a785fb40be237d36bdd4377d4921 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 21 Jul 2025 00:39:17 +0000 Subject: [PATCH 40/41] Remove files --- index.d.ts | 285 --- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5132 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 7a87f5a..0000000 --- a/index.d.ts +++ /dev/null @@ -1,285 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; -import * as random from '@stdlib/types/random'; - -/** -* Output array. -*/ -type RandomArray = FloatTypedArray | Array; - -/** -* Interface defining PRNG options. -*/ -interface PRNGOptions { - /** - * Pseudorandom number generator which generates uniformly distributed pseudorandom numbers. - */ - prng?: random.PRNG; - - /** - * Pseudorandom number generator seed. - */ - seed?: random.PRNGSeedMT19937; - - /** - * Pseudorandom number generator state. - */ - state?: random.PRNGStateMT19937; - - /** - * Specifies whether to copy a provided pseudorandom number generator state. Default: true. - */ - copy?: boolean; -} - -/** -* Interface defining factory options. -*/ -interface FactoryOptions extends PRNGOptions { - /** - * Default output array data type. Default: 'float64'. - */ - dtype?: DataType; -} - -/** -* Interface defining options. -*/ -interface Options { - /** - * Output array data type. - */ - dtype?: DataType; -} - -/** -* Interface for PRNG properties and methods. -*/ -interface PRNG { - /** - * Underlying pseudorandom number generator. - */ - readonly PRNG: random.PRNG; - - /** - * PRNG seed. - */ - readonly seed: random.PRNGSeedMT19937 | null; - - /** - * PRNG seed length. - */ - readonly seedLength: number | null; - - /** - * PRNG state. - */ - state: random.PRNGStateMT19937 | null; - - /** - * PRNG state length. - */ - readonly stateLength: number | null; - - /** - * PRNG state size (in bytes). - */ - readonly byteLength: number | null; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution with pre-specified parameter values. -*/ -interface UnaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param options - function options - * @returns output array - */ - ( len: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param out - output array - * @returns output array - */ - assign( out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution without pre-specified parameter values. -*/ -interface QuaternaryFunction extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; -} - -/** -* Interface for generating pseudorandom numbers drawn from a triangular distribution. -*/ -interface Random extends PRNG { - /** - * Returns an array containing pseudorandom numbers drawn from a triangular distribution. - * - * @param len - array length - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @returns output array - * - * @example - * var out = triangular( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - ( len: number, a: number, b: number, c: number, options?: Options ): RandomArray; - - /** - * Fills an array with pseudorandom numbers drawn from a triangular distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param out - output array - * @returns output array - * - * @example - * var zeros = require( '@stdlib/array-zeros' ); - * - * var x = zeros( 10, 'float64' ); - * // returns - * - * var out = triangular( 2.0, 5.0, 3.0, out ); - * // returns - * - * var bool = ( out === x ); - * // returns true - */ - assign( a: number, b: number, c: number, out: RandomArray ): RandomArray; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution. - * - * @param a - minimum support - * @param b - maximum support - * @param c - mode - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0 ); - * - * var out = random( 10 ); - * // returns - * - * @example - * var random = triangular.factory( 2.0, 5.0, 3.0, { - * 'seed': 297 - * }); - * var out = random( 10 ); - * // returns - */ - factory( a: number, b: number, c: number, options?: FactoryOptions ): UnaryFunction; - - /** - * Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. - * - * ## Notes - * - * - When not provided distribution parameters, the returned function requires that distribution parameters be provided at each invocation. - * - * @param options - function options - * @throws must provide a valid state - * @returns function for creating arrays - * - * @example - * var random = triangular.factory(); - * - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - * - * @example - * var random = triangular.factory({ - * 'seed': 297 - * }); - * var out = random( 10, 2.0, 5.0, 3.0 ); - * // returns - */ - factory( options?: FactoryOptions ): QuaternaryFunction; -} - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @param len - array length -* @param a - minimum support -* @param b - maximum support -* @param c - mode -* @param options - function options -* @returns output array -* -* @example -* var out = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var random = triangular.factory( 2.0, 5.0, 3.0 ); -* -* var out = random( 10 ); -* // returns -*/ -declare var triangular: Random; - - -// EXPORTS // - -export = triangular; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c65043e..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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.3.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; -//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map deleted file mode 100644 index 53bb781..0000000 --- a/index.mjs.map +++ /dev/null @@ -1 +0,0 @@ -{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e4b78fa..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 8d5d36961f1bdf22e59f2eb41b8a78e144ccdde7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 21 Jul 2025 00:39:43 +0000 Subject: [PATCH 41/41] 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 | 80 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 65 +- SECURITY.md | 5 - benchmark/benchmark.float32.assign.js | 97 - benchmark/benchmark.float32.factory.js | 96 - benchmark/benchmark.float32.js | 98 - benchmark/benchmark.float64.assign.js | 97 - benchmark/benchmark.float64.factory.js | 96 - benchmark/benchmark.float64.js | 98 - benchmark/benchmark.generic.assign.js | 97 - benchmark/benchmark.generic.factory.js | 96 - benchmark/benchmark.generic.js | 98 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 207 - docs/types/test.ts | 472 -- examples/index.js | 48 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/factory.js | 79 - lib/index.js | 77 - lib/main.js | 59 - package.json | 71 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 118 - test/test.factory.js | 1334 ----- test/test.js | 74 - test/test.main.js | 244 - 56 files changed, 4882 insertions(+), 7163 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.float32.assign.js delete mode 100644 benchmark/benchmark.float32.factory.js delete mode 100644 benchmark/benchmark.float32.js delete mode 100644 benchmark/benchmark.float64.assign.js delete mode 100644 benchmark/benchmark.float64.factory.js delete mode 100644 benchmark/benchmark.float64.js delete mode 100644 benchmark/benchmark.generic.assign.js delete mode 100644 benchmark/benchmark.generic.factory.js delete mode 100644 benchmark/benchmark.generic.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/factory.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.factory.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index fa49079..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-07-21T00:37:09.376Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 7917a9c..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/triangular) 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 7ca4452..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/triangular) 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 06b6d84..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: '9 21 * * 5' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -408,7 +405,7 @@ logEach( '%f', x4 ); ## 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]. @@ -471,13 +468,13 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/random-array-triangular/main/LICENSE -[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular +[@stdlib/random/base/triangular]: https://github.com/stdlib-js/random-base-triangular/tree/esm -[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes +[@stdlib/array/typed-real-float-dtypes]: https://github.com/stdlib-js/array-typed-real-float-dtypes/tree/esm -[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32 +[@stdlib/array/uint32]: https://github.com/stdlib-js/array-uint32/tree/esm -[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64 +[@stdlib/array/float64]: https://github.com/stdlib-js/array-float64/tree/esm
diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 9702d4c..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,5 +0,0 @@ -# Security - -> Policy for reporting security vulnerabilities. - -See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security). diff --git a/benchmark/benchmark.float32.assign.js b/benchmark/benchmark.float32.assign.js deleted file mode 100644 index 9c446cc..0000000 --- a/benchmark/benchmark.float32.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'float32' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.0, out ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.factory.js b/benchmark/benchmark.float32.factory.js deleted file mode 100644 index 505fdf3..0000000 --- a/benchmark/benchmark.float32.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench-harness' ); -var isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - 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 = fcn( len ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+'::factory:dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float32.js b/benchmark/benchmark.float32.js deleted file mode 100644 index dfa253f..0000000 --- a/benchmark/benchmark.float32.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isnanf = require( '@stdlib/math-base-assert-is-nanf' ); -var pow = require( '@stdlib/math-base-special-pow' ); -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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float32' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - if ( isnanf( o[ i%len ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - if ( isnanf( 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+':dtype=float32,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.assign.js b/benchmark/benchmark.float64.assign.js deleted file mode 100644 index 6aa30c9..0000000 --- a/benchmark/benchmark.float64.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - 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, 3.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:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.factory.js b/benchmark/benchmark.float64.factory.js deleted file mode 100644 index ad44c11..0000000 --- a/benchmark/benchmark.float64.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': '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 = fcn( len ); - 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+'::factory:dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.float64.js b/benchmark/benchmark.float64.js deleted file mode 100644 index 8295731..0000000 --- a/benchmark/benchmark.float64.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'float64' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=float64,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.assign.js b/benchmark/benchmark.generic.assign.js deleted file mode 100644 index 925fdd4..0000000 --- a/benchmark/benchmark.generic.assign.js +++ /dev/null @@ -1,97 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var o; - var i; - - out = zeros( len, 'generic' ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random.assign( 2.0, 5.0, 3.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:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.factory.js b/benchmark/benchmark.generic.factory.js deleted file mode 100644 index bfb7765..0000000 --- a/benchmark/benchmark.generic.factory.js +++ /dev/null @@ -1,96 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'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 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 fcn = random.factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - 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 = fcn( len ); - 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+'::factory:dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/benchmark/benchmark.generic.js b/benchmark/benchmark.generic.js deleted file mode 100644 index 62b8302..0000000 --- a/benchmark/benchmark.generic.js +++ /dev/null @@ -1,98 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 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 ) { - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var opts; - var o; - var i; - - opts = { - 'dtype': 'generic' - }; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - o = random( len, 2.0, 5.0, 3.0, opts ); - 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+':dtype=generic,len='+len, f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index da0eed7..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/triangular" -%% click B href "https://github.com/stdlib-js/random-array-triangular/tree/main" -%% click C href "https://github.com/stdlib-js/random-array-triangular/tree/production" -%% click D href "https://github.com/stdlib-js/random-array-triangular/tree/esm" -%% click E href "https://github.com/stdlib-js/random-array-triangular/tree/deno" -%% click F href "https://github.com/stdlib-js/random-array-triangular/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/triangular -[production-url]: https://github.com/stdlib-js/random-array-triangular/tree/production -[deno-url]: https://github.com/stdlib-js/random-array-triangular/tree/deno -[deno-readme]: https://github.com/stdlib-js/random-array-triangular/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/random-array-triangular/tree/umd -[umd-readme]: https://github.com/stdlib-js/random-array-triangular/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/random-array-triangular/tree/esm -[esm-readme]: https://github.com/stdlib-js/random-array-triangular/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 8dbf870..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import triangular from '../docs/types/index'; -export = triangular; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index cb3195c..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var a=function(o,r){return function(){return r||o((r={exports:{}}).exports,r),r.exports}};var e=a(function(x,t){ -var v=require('@stdlib/random-array-tools-ternary-factory/dist'),n=require('@stdlib/array-dtypes/dist'),c=require('@stdlib/array-defaults/dist'),y=require('@stdlib/random-base-triangular/dist'),q=n("real_floating_point_and_generic"),f=v(y,q,c.get("dtypes.real_floating_point"));t.exports=f -});var s=a(function(b,i){ -var l=e(),p=l();i.exports=p -});var _=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),u=s(),d=e();_(u,"factory",d);module.exports=u; -/** @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 bce90bb..0000000 --- a/dist/index.js.map +++ /dev/null @@ -1,7 +0,0 @@ -{ - "version": 3, - "sources": ["../lib/factory.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 ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' );\nvar dtypes = require( '@stdlib/array-dtypes' );\nvar defaults = require( '@stdlib/array-defaults' );\nvar base = require( '@stdlib/random-base-triangular' );\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nmodule.exports = factory;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2024 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nmodule.exports = triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* var triangular = require( '@stdlib/random-array-triangular' );\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,4CAA6C,EACvEC,EAAS,QAAS,sBAAuB,EACzCC,EAAW,QAAS,wBAAyB,EAC7CC,EAAO,QAAS,gCAAiC,EAKjDC,EAASH,EAAQ,iCAAkC,EA2CnDI,EAAUL,EAAgBG,EAAMC,EAAQF,EAAS,IAAK,4BAA6B,CAAE,EAKzFH,EAAO,QAAUM,IC9EjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAU,IA+BVC,EAAaD,EAAQ,EAKzBD,EAAO,QAAUE,ICIjB,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD", - "names": ["require_factory", "__commonJSMin", "exports", "module", "ternaryFactory", "dtypes", "defaults", "base", "DTYPES", "factory", "require_main", "__commonJSMin", "exports", "module", "factory", "triangular", "setReadOnly", "main", "factory"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index c4eee23..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,207 +0,0 @@ - -{{alias}}( len, a, b, c[, options] ) - Returns an array containing pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - len: integer - Output array length. - - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - options: Object (optional) - Options. - - options.dtype: string (optional) - Output array data type. Default: 'float64'. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.assign( a, b, c, out ) - Fills an array with pseudorandom numbers drawn from a triangular - distribution. - - Parameters - ---------- - a: number - Minimum support. - - b: number - Maximum support. - - c: number - Mode. - - out: Array|Float64Array|Float32Array - Output array. - - Returns - ------- - out: Array|Float64Array|Float32Array - Output array. - - Examples - -------- - > var x = {{alias:@stdlib/array/zeros}}( 3, 'float64' ); - > var out = {{alias}}.assign( 2.0, 5.0, 3.0, x ) - - > var bool = ( out === x ) - true - - -{{alias}}.factory( [a, b, c, ][options] ) - Returns a function for creating arrays containing pseudorandom numbers drawn - from a triangular distribution. - - If provided distribution parameters, the returned function returns random - variates drawn from the specified distribution. - - If not provided distribution parameters, the returned function requires that - distribution parameters be provided at each invocation. - - The returned function accepts the following options: - - - dtype: output array data type. This overrides the default output array - data type. - - Parameters - ---------- - a: number (optional) - Minimum support. - - b: number (optional) - Maximum support. - - c: number (optional) - Mode. - - options: Object (optional) - Options. - - options.prng: Function (optional) - Pseudorandom number generator (PRNG) for generating uniformly - distributed pseudorandom numbers on the interval `[0,1)`. If provided, - the `state` and `seed` options are ignored. In order to seed the - returned pseudorandom number generator, one must seed the provided - `prng` (assuming the provided `prng` is seedable). - - options.seed: integer|ArrayLikeObject (optional) - Pseudorandom number generator seed. The seed may be either a positive - unsigned 32-bit integer or, for arbitrary length seeds, an array-like - object containing unsigned 32-bit integers. - - options.state: Uint32Array (optional) - Pseudorandom number generator state. If provided, the `seed` option is - ignored. - - options.copy: boolean (optional) - Boolean indicating whether to copy a provided pseudorandom number - generator state. Setting this option to `false` allows sharing state - between two or more pseudorandom number generators. Setting this option - to `true` ensures that a returned generator has exclusive control over - its internal state. Default: true. - - options.dtype: string (optional) - Default output array data type. Default: 'float64'. - - Returns - ------- - fcn: Function - Function for creating arrays. - - Examples - -------- - > var fcn = {{alias}}.factory(); - > var out = fcn( 3, 2.0, 5.0, 3.0 ) - - - // Provide distribution parameters: - > fcn = {{alias}}.factory( 2.0, 5.0, 3.0 ); - > out = fcn( 3 ) - - - -{{alias}}.PRNG - Underlying pseudorandom number generator. - - Examples - -------- - > var prng = {{alias}}.PRNG; - - -{{alias}}.seed - Pseudorandom number generator seed. - - Examples - -------- - > var seed = {{alias}}.seed; - - -{{alias}}.seedLength - Length of generator seed. - - Examples - -------- - > var len = {{alias}}.seedLength; - - -{{alias}}.state - Generator state. - - Examples - -------- - > var out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Get a copy of the current state: - > var state = {{alias}}.state - - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - // Set the state: - > {{alias}}.state = state; - - // Regenerate a previous array: - > out = {{alias}}( 3, 2.0, 5.0, 3.0 ) - - - -{{alias}}.stateLength - Length of generator state. - - Examples - -------- - > var len = {{alias}}.stateLength; - - -{{alias}}.byteLength - Size (in bytes) of generator state. - - Examples - -------- - > var sz = {{alias}}.byteLength; - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index e096d5f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,472 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -import zeros = require( '@stdlib/array-zeros' ); -import random = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - random( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray - random( 10, 2.0, 5.0, 3.0, {} ); // $ExpectType RandomArray -} - -// The compiler throws an error if the function is provided a first argument which is not a number... -{ - random( '5', 2.0, 5.0, 3.0 ); // $ExpectError - random( true, 2.0, 5.0, 3.0 ); // $ExpectError - random( false, 2.0, 5.0, 3.0 ); // $ExpectError - random( null, 2.0, 5.0, 3.0 ); // $ExpectError - random( [], 2.0, 5.0, 3.0 ); // $ExpectError - random( {}, 2.0, 5.0, 3.0 ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - random( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - random( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( null, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - random( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - random( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not a number... -{ - random( 10, '5', 5.0, 3.0 ); // $ExpectError - random( 10, true, 5.0, 3.0 ); // $ExpectError - random( 10, false, 5.0, 3.0 ); // $ExpectError - random( 10, null, 5.0, 3.0 ); // $ExpectError - random( 10, [], 5.0, 3.0 ); // $ExpectError - random( 10, {}, 5.0, 3.0 ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random( 10, '5', 5.0, 3.0, {} ); // $ExpectError - random( 10, true, 5.0, 3.0, {} ); // $ExpectError - random( 10, false, 5.0, 3.0, {} ); // $ExpectError - random( 10, null, 5.0, 3.0, {} ); // $ExpectError - random( 10, [], 5.0, 3.0, {} ); // $ExpectError - random( 10, {}, 5.0, 3.0, {} ); // $ExpectError - random( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a number... -{ - random( 10, 2.0, '5', 3.0 ); // $ExpectError - random( 10, 2.0, true, 3.0 ); // $ExpectError - random( 10, 2.0, false, 3.0 ); // $ExpectError - random( 10, 2.0, null, 3.0 ); // $ExpectError - random( 10, 2.0, [], 3.0 ); // $ExpectError - random( 10, 2.0, {}, 3.0 ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random( 10, 2.0, '5', 3.0, {} ); // $ExpectError - random( 10, 2.0, true, 3.0, {} ); // $ExpectError - random( 10, 2.0, false, 3.0, {} ); // $ExpectError - random( 10, 2.0, null, 3.0, {} ); // $ExpectError - random( 10, 2.0, [], 3.0, {} ); // $ExpectError - random( 10, 2.0, {}, 3.0, {} ); // $ExpectError - random( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a number... -{ - random( 10, 2.0, 5.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, true ); // $ExpectError - random( 10, 2.0, 5.0, false ); // $ExpectError - random( 10, 2.0, 5.0, null ); // $ExpectError - random( 10, 2.0, 5.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random( 10, 2.0, 5.0, '5', {} ); // $ExpectError - random( 10, 2.0, 5.0, true, {} ); // $ExpectError - random( 10, 2.0, 5.0, false, {} ); // $ExpectError - random( 10, 2.0, 5.0, null, {} ); // $ExpectError - random( 10, 2.0, 5.0, [], {} ); // $ExpectError - random( 10, 2.0, 5.0, {}, {} ); // $ExpectError - random( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an options argument which is not a valid object... -{ - random( 10, 2.0, 5.0, 3.0, '5' ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, 5 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, true ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, false ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, [] ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a `dtype` option which is not a supported data type... -{ - random( 10, 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - random(); // $ExpectError - random( 10 ); // $ExpectError - random( 10, 2.0 ); // $ExpectError - random( 10, 2.0, 5.0 ); // $ExpectError - random( 10, 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns an array... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, 3.0, x ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( '5', 5.0, 3.0, x ); // $ExpectError - random.assign( true, 5.0, 3.0, x ); // $ExpectError - random.assign( false, 5.0, 3.0, x ); // $ExpectError - random.assign( null, 5.0, 3.0, x ); // $ExpectError - random.assign( [], 5.0, 3.0, x ); // $ExpectError - random.assign( {}, 5.0, 3.0, x ); // $ExpectError - random.assign( ( x: number ): number => x, 5.0, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, '5', 3.0, x ); // $ExpectError - random.assign( 2.0, true, 3.0, x ); // $ExpectError - random.assign( 2.0, false, 3.0, x ); // $ExpectError - random.assign( 2.0, null, 3.0, x ); // $ExpectError - random.assign( 2.0, [], 3.0, x ); // $ExpectError - random.assign( 2.0, {}, 3.0, x ); // $ExpectError - random.assign( 2.0, ( x: number ): number => x, 3.0, x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a number... -{ - const x = zeros( 10, 'float64' ); - - random.assign( 2.0, 5.0, '5', x ); // $ExpectError - random.assign( 2.0, 5.0, true, x ); // $ExpectError - random.assign( 2.0, 5.0, false, x ); // $ExpectError - random.assign( 2.0, 5.0, null, x ); // $ExpectError - random.assign( 2.0, 5.0, [], x ); // $ExpectError - random.assign( 2.0, 5.0, {}, x ); // $ExpectError - random.assign( 2.0, 5.0, ( x: number ): number => x, x ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a valid output array... -{ - random.assign( 2.0, 5.0, 3.0, '5' ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, 5 ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, true ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, false ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, null ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, {} ); // $ExpectError - random.assign( 2.0, 5.0, 3.0, ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = zeros( 10, 'float64' ); - - random.assign(); // $ExpectError - random.assign( x ); // $ExpectError - random.assign( x, 2.0 ); // $ExpectError - random.assign( x, 2.0, 5.0 ); // $ExpectError - random.assign( x, 2.0, 5.0, 3.0, {} ); // $ExpectError -} - -// Attached to main export is a `factory` method which returns a function... -{ - random.factory( 2.0, 5.0, 3.0 ); // $ExpectType UnaryFunction - random.factory( 2.0, 5.0, 3.0, { 'copy': false } ); // $ExpectType UnaryFunction - - random.factory(); // $ExpectType QuaternaryFunction - random.factory( { 'copy': false } ); // $ExpectType QuaternaryFunction -} - -// The `factory` method returns a function which returns an array... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( 10 ); // $ExpectType RandomArray - - const fcn2 = random.factory(); - fcn2( 10, 2.0, 5.0, 3.0 ); // $ExpectType RandomArray -} - -// The compiler throws an error if the `factory` method is provided invalid arguments... -{ - random.factory( '5', 5.0, 3.0 ); // $ExpectError - random.factory( true, 5.0, 3.0 ); // $ExpectError - random.factory( false, 5.0, 3.0 ); // $ExpectError - random.factory( [], 5.0, 3.0 ); // $ExpectError - random.factory( {}, 5.0, 3.0 ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - random.factory( '5', 5.0, 3.0, {} ); // $ExpectError - random.factory( true, 5.0, 3.0, {} ); // $ExpectError - random.factory( false, 5.0, 3.0, {} ); // $ExpectError - random.factory( [], 5.0, 3.0, {} ); // $ExpectError - random.factory( {}, 5.0, 3.0, {} ); // $ExpectError - random.factory( ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - random.factory( 2.0, '5', 3.0 ); // $ExpectError - random.factory( 2.0, true, 3.0 ); // $ExpectError - random.factory( 2.0, false, 3.0 ); // $ExpectError - random.factory( 2.0, [], 3.0 ); // $ExpectError - random.factory( 2.0, {}, 3.0 ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - random.factory( 2.0, '5', 3.0, {} ); // $ExpectError - random.factory( 2.0, true, 3.0, {} ); // $ExpectError - random.factory( 2.0, false, 3.0, {} ); // $ExpectError - random.factory( 2.0, [], 3.0, {} ); // $ExpectError - random.factory( 2.0, {}, 3.0, {} ); // $ExpectError - random.factory( 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - random.factory( 2.0, 5.0, '5' ); // $ExpectError - random.factory( 2.0, 5.0, true ); // $ExpectError - random.factory( 2.0, 5.0, false ); // $ExpectError - random.factory( 2.0, 5.0, [] ); // $ExpectError - random.factory( 2.0, 5.0, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - random.factory( 2.0, 5.0, '5', {} ); // $ExpectError - random.factory( 2.0, 5.0, true, {} ); // $ExpectError - random.factory( 2.0, 5.0, false, {} ); // $ExpectError - random.factory( 2.0, 5.0, [], {} ); // $ExpectError - random.factory( 2.0, 5.0, {}, {} ); // $ExpectError - random.factory( 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided an options argument which is not a valid object... -{ - random.factory( null ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, null ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `prng` option which is not a pseudorandom number generator... -{ - random.factory( 2.0, 5.0, 3.0, { 'prng': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'prng': true } ); // $ExpectError - - random.factory( { 'prng': 123 } ); // $ExpectError - random.factory( { 'prng': 'abc' } ); // $ExpectError - random.factory( { 'prng': null } ); // $ExpectError - random.factory( { 'prng': [] } ); // $ExpectError - random.factory( { 'prng': {} } ); // $ExpectError - random.factory( { 'prng': true } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `seed` option which is not a valid seed... -{ - random.factory( 2.0, 5.0, 3.0, { 'seed': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'seed': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'seed': true } ); // $ExpectError - random.factory( { 'seed': 'abc' } ); // $ExpectError - random.factory( { 'seed': null } ); // $ExpectError - random.factory( { 'seed': [ 'a' ] } ); // $ExpectError - random.factory( { 'seed': {} } ); // $ExpectError - random.factory( { 'seed': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `state` option which is not a valid state... -{ - random.factory( 2.0, 5.0, 3.0, { 'state': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': true } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'state': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'state': 123 } ); // $ExpectError - random.factory( { 'state': 'abc' } ); // $ExpectError - random.factory( { 'state': null } ); // $ExpectError - random.factory( { 'state': [] } ); // $ExpectError - random.factory( { 'state': {} } ); // $ExpectError - random.factory( { 'state': true } ); // $ExpectError - random.factory( { 'state': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `copy` option which is not a boolean... -{ - random.factory( 2.0, 5.0, 3.0, { 'copy': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'copy': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'copy': 123 } ); // $ExpectError - random.factory( { 'copy': 'abc' } ); // $ExpectError - random.factory( { 'copy': null } ); // $ExpectError - random.factory( { 'copy': [] } ); // $ExpectError - random.factory( { 'copy': {} } ); // $ExpectError - random.factory( { 'copy': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided a `dtype` option which is not a supported data type... -{ - random.factory( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - random.factory( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - random.factory( { 'dtype': 123 } ); // $ExpectError - random.factory( { 'dtype': 'abc' } ); // $ExpectError - random.factory( { 'dtype': null } ); // $ExpectError - random.factory( { 'dtype': [] } ); // $ExpectError - random.factory( { 'dtype': {} } ); // $ExpectError - random.factory( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the `factory` method is provided more than three arguments... -{ - random.factory( 2.0, 5.0, 3.0, {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided invalid arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1( '5' ); // $ExpectError - fcn1( true ); // $ExpectError - fcn1( false ); // $ExpectError - fcn1( null ); // $ExpectError - fcn1( [] ); // $ExpectError - fcn1( {} ); // $ExpectError - fcn1( ( x: number ): number => x ); // $ExpectError - - fcn1( '5', {} ); // $ExpectError - fcn1( true, {} ); // $ExpectError - fcn1( false, {} ); // $ExpectError - fcn1( null, {} ); // $ExpectError - fcn1( [], {} ); // $ExpectError - fcn1( {}, {} ); // $ExpectError - fcn1( ( x: number ): number => x, {} ); // $ExpectError - - const fcn2 = random.factory(); - fcn2( true, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0 ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0 ); // $ExpectError - - fcn2( true, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( false, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( '5', 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( [], 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( {}, 2.0, 5.0, 3.0, {} ); // $ExpectError - fcn2( ( x: number ): number => x, 2.0, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0 ); // $ExpectError - fcn2( 10, false, 5.0, 3.0 ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0 ); // $ExpectError - fcn2( 10, [], 5.0, 3.0 ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0 ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0 ); // $ExpectError - - fcn2( 10, true, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, false, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, '5', 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, [], 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, {}, 5.0, 3.0, {} ); // $ExpectError - fcn2( 10, ( x: number ): number => x, 5.0, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0 ); // $ExpectError - fcn2( 10, 2.0, false, 3.0 ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0 ); // $ExpectError - fcn2( 10, 2.0, [], 3.0 ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0 ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0 ); // $ExpectError - - fcn2( 10, 2.0, true, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, false, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, '5', 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, [], 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, {}, 3.0, {} ); // $ExpectError - fcn2( 10, 2.0, ( x: number ): number => x, 3.0, {} ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true ); // $ExpectError - fcn2( 10, 2.0, 5.0, false ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5' ); // $ExpectError - fcn2( 10, 2.0, 5.0, [] ); // $ExpectError - fcn2( 10, 2.0, 5.0, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x ); // $ExpectError - - fcn2( 10, 2.0, 5.0, true, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, false, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, '5', {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, [], {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, {}, {} ); // $ExpectError - fcn2( 10, 2.0, 5.0, ( x: number ): number => x, {} ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided a `dtype` option which is not a supported data type... -{ - const fcn1 = random.factory(); - fcn1( 2.0, 5.0, 3.0, { 'dtype': 123 } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': 'abc' } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': null } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': [] } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': {} } ); // $ExpectError - fcn1( 2.0, 5.0, 3.0, { 'dtype': ( x: number ): number => x } ); // $ExpectError - - const fcn2 = random.factory( 2.0, 5.0, 3.0 ); - fcn2( { 'dtype': 123 } ); // $ExpectError - fcn2( { 'dtype': 'abc' } ); // $ExpectError - fcn2( { 'dtype': null } ); // $ExpectError - fcn2( { 'dtype': [] } ); // $ExpectError - fcn2( { 'dtype': {} } ); // $ExpectError - fcn2( { 'dtype': ( x: number ): number => x } ); // $ExpectError -} - -// The compiler throws an error if the function returned by the `factory` method is provided an unsupported number of arguments... -{ - const fcn1 = random.factory( 2.0, 5.0, 3.0 ); - fcn1(); // $ExpectError - fcn1( 1, 1, 1 ); // $ExpectError - - const fcn2 = random.factory(); - fcn2(); // $ExpectError - fcn2( 1 ); // $ExpectError - fcn2( 1, 1 ); // $ExpectError - fcn2( 1, 1, 1, 1, 1 ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index dc8baec..0000000 --- a/examples/index.js +++ /dev/null @@ -1,48 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -var logEach = require( '@stdlib/console-log-each' ); -var triangular = require( './../lib' ); - -// Create a function for generating random arrays originating from the same state: -var random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate 3 arrays: -var x1 = random( 5 ); -var x2 = random( 5 ); -var x3 = random( 5 ); - -// Print the contents: -logEach( '%f, %f, %f', x1, x2, x3 ); - -// Create another function for generating random arrays with the original state: -random = triangular.factory( 2.0, 5.0, 3.0, { - 'state': triangular.state, - 'copy': true -}); - -// Generate a single array which replicates the above pseudorandom number generation sequence: -var x4 = random( 15 ); - -// Print the contents: -logEach( '%f', x4 ); 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 d3467fa..7a87f5a 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { RealFloatingPointAndGenericDataType as DataType, FloatTypedArray } from '@stdlib/types/array'; import * as random from '@stdlib/types/random'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c65043e --- /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 e from"https://cdn.jsdelivr.net/gh/stdlib-js/random-array-tools-ternary-factory@v0.2.2-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/array-dtypes@v0.3.0-esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/array-defaults@v0.3.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/random-base-triangular@v0.2.1-esm/index.mjs";var d=e(n,r("real_floating_point_and_generic"),s.get("dtypes.real_floating_point")),i=d();t(i,"factory",d);export{i as default,d as factory}; +//# sourceMappingURL=index.mjs.map diff --git a/index.mjs.map b/index.mjs.map new file mode 100644 index 0000000..53bb781 --- /dev/null +++ b/index.mjs.map @@ -0,0 +1 @@ +{"version":3,"file":"index.mjs","sources":["../lib/factory.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\nimport ternaryFactory from '@stdlib/random-array-tools-ternary-factory';\nimport dtypes from '@stdlib/array-dtypes';\nimport defaults from '@stdlib/array-defaults';\nimport base from '@stdlib/random-base-triangular';\n\n\n// VARIABLES //\n\nvar DTYPES = dtypes( 'real_floating_point_and_generic' );\n\n\n// MAIN //\n\n/**\n* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name factory\n* @type {Function}\n* @param {number} [a] - minimum support\n* @param {number} [b] - maximum support\n* @param {number} [c] - mode\n* @param {Options} [options] - function options\n* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers\n* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed\n* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state\n* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state\n* @param {string} [options.dtype=\"float64\"] - default data type\n* @throws {TypeError} `a` must be a number\n* @throws {TypeError} `b` must be a number\n* @throws {TypeError} `c` must be a number\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @throws {Error} must provide a valid state\n* @returns {Function} function for creating arrays\n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10 );\n* // returns \n*\n* @example\n* var triangular = factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = triangular( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) );\n\n\n// EXPORTS //\n\nexport default factory;\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 factory from './factory.js';\n\n\n// MAIN //\n\n/**\n* Returns an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @name triangular\n* @type {Function}\n* @param {NonNegativeInteger} len - array length\n* @param {number} a - minimum support\n* @param {number} b - maximum support\n* @param {number} c - mode\n* @param {Options} [options] - options\n* @param {string} [options.dtype=\"float64\"] - output 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 {(Array|TypedArray)} output array\n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\nvar triangular = factory();\n\n\n// EXPORTS //\n\nexport default triangular;\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* Create an array containing pseudorandom numbers drawn from a triangular distribution.\n*\n* @module @stdlib/random-array-triangular\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var arr = triangular( 10, 2.0, 5.0, 3.0, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10 );\n* // returns \n*\n* @example\n* import triangular from '@stdlib/random-array-triangular';\n*\n* var rand = triangular.factory( 2.0, 5.0, 3.0 );\n* // returns \n*\n* var arr = rand( 10, {\n* 'dtype': 'generic'\n* });\n* // returns [...]\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport factory from './factory.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nexport default main;\n\n// exports: { \"factory\": \"main.factory\", \"assign\": \"main.assign\" }\n"],"names":["factory","ternaryFactory","base","dtypes","defaults","get","triangular","setReadOnly","main"],"mappings":";;sfA8BA,IA2CIA,EAAUC,EAAgBC,EA3CjBC,EAAQ,mCA2CuBC,EAASC,IAAK,+BCpBtDC,EAAaN,ICgBjBO,EAAAC,EAAA,UAAAR"} \ No newline at end of file diff --git a/lib/factory.js b/lib/factory.js deleted file mode 100644 index cf0c1e2..0000000 --- a/lib/factory.js +++ /dev/null @@ -1,79 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var ternaryFactory = require( '@stdlib/random-array-tools-ternary-factory' ); -var dtypes = require( '@stdlib/array-dtypes' ); -var defaults = require( '@stdlib/array-defaults' ); -var base = require( '@stdlib/random-base-triangular' ); - - -// VARIABLES // - -var DTYPES = dtypes( 'real_floating_point_and_generic' ); - - -// MAIN // - -/** -* Returns a function for creating arrays containing pseudorandom numbers drawn from a triangular distribution. -* -* @name factory -* @type {Function} -* @param {number} [a] - minimum support -* @param {number} [b] - maximum support -* @param {number} [c] - mode -* @param {Options} [options] - function options -* @param {PRNG} [options.prng] - pseudorandom number generator which generates uniformly distributed pseudorandom numbers -* @param {PRNGSeedMT19937} [options.seed] - pseudorandom number generator seed -* @param {PRNGStateMT19937} [options.state] - pseudorandom number generator state -* @param {boolean} [options.copy=true] - boolean indicating whether to copy a provided pseudorandom number generator state -* @param {string} [options.dtype="float64"] - default data type -* @throws {TypeError} `a` must be a number -* @throws {TypeError} `b` must be a number -* @throws {TypeError} `c` must be a number -* @throws {TypeError} options argument must be an object -* @throws {TypeError} must provide valid options -* @throws {Error} must provide a valid state -* @returns {Function} function for creating arrays -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10 ); -* // returns -* -* @example -* var triangular = factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = triangular( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var factory = ternaryFactory( base, DTYPES, defaults.get( 'dtypes.real_floating_point' ) ); - - -// EXPORTS // - -module.exports = factory; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 0c9cc45..0000000 --- a/lib/index.js +++ /dev/null @@ -1,77 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Create an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @module @stdlib/random-array-triangular -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10 ); -* // returns -* -* @example -* var triangular = require( '@stdlib/random-array-triangular' ); -* -* var rand = triangular.factory( 2.0, 5.0, 3.0 ); -* // returns -* -* var arr = rand( 10, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var factory = require( './factory.js' ); - - -// MAIN // - -setReadOnly( main, 'factory', factory ); - - -// EXPORTS // - -module.exports = main; - -// exports: { "factory": "main.factory", "assign": "main.assign" } diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 007f7b4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,59 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var factory = require( './factory.js' ); - - -// MAIN // - -/** -* Returns an array containing pseudorandom numbers drawn from a triangular distribution. -* -* @name triangular -* @type {Function} -* @param {NonNegativeInteger} len - array length -* @param {number} a - minimum support -* @param {number} b - maximum support -* @param {number} c - mode -* @param {Options} [options] - options -* @param {string} [options.dtype="float64"] - output 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 {(Array|TypedArray)} output array -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0 ); -* // returns -* -* @example -* var arr = triangular( 10, 2.0, 5.0, 3.0, { -* 'dtype': 'generic' -* }); -* // returns [...] -*/ -var triangular = factory(); - - -// EXPORTS // - -module.exports = triangular; diff --git a/package.json b/package.json index 3297722..4d7b994 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Create an array containing pseudorandom numbers drawn from a triangular distribution.", "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-defaults": "^0.3.0", - "@stdlib/array-dtypes": "^0.3.0", - "@stdlib/random-array-tools-ternary-factory": "^0.2.2", - "@stdlib/random-base-triangular": "^0.2.1", - "@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-float32": "^0.2.2", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/array-nans": "^0.2.1", - "@stdlib/array-uint32": "^0.2.2", - "@stdlib/array-zeros": "^0.2.2", - "@stdlib/assert-is-uint32array": "^0.2.2", - "@stdlib/console-log-each": "^0.2.2", - "@stdlib/constants-uint32-max": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-assert-is-nanf": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/random-base-minstd": "^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", @@ -102,4 +37,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..e4b78fa --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index 673c43d..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,118 +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 nans = require( '@stdlib/array-nans' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'the method throws an error if provided a third argument which is not an array-like object', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - NaN, - null, - true, - false, - void 0, - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random.assign( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float64)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float64' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=float32)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'float32' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the method fills an output array with pseudorandom numbers (dtype=generic)', function test( t ) { - var actual; - var out; - var i; - - out = nans( 10, 'generic' ); - actual = random.assign( 2.0, 5.0, 3.0, out ); - - t.strictEqual( out, actual, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); diff --git a/test/test.factory.js b/test/test.factory.js deleted file mode 100644 index ea8d4a0..0000000 --- a/test/test.factory.js +++ /dev/null @@ -1,1334 +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 isUint32Array = require( '@stdlib/assert-is-uint32array' ); -var UINT32_MAX = require( '@stdlib/constants-uint32-max' ); -var Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var Uint32Array = require( '@stdlib/array-uint32' ); -var minstd = require( '@stdlib/random-base-minstd' ); -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var factory = require( './../lib/factory.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof factory, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid first distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid second distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, value, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid third distribution parameter (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, value, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( value ); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `prng` option which is not a function, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - NaN, - true, - false, - null, - void 0, - [], - {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'prng': value - }); - }; - } -}); - -tape( 'if provided a `copy` option which is not a boolean, the function throws an error', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'copy': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `seed` which is not a positive integer or a non-empty array-like object, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 3.14, - 0.0, - -5.0, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'seed': value - }); - }; - } -}); - -tape( 'the function throws a range error if provided a `seed` which is an integer greater than the maximum unsigned 32-bit integer (no parameters)', function test( t ) { - var values; - var i; - - values = [ - UINT32_MAX + 1, - UINT32_MAX + 2, - UINT32_MAX + 3 - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws a range error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'seed': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided a `state` option which is not a Uint32Array, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'state': value - }); - }; - } -}); - -tape( 'if provided an invalid `state` option, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - new Uint32Array( 0 ), - new Uint32Array( 10 ), - new Uint32Array( 100 ) - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), RangeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'state': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory( 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'if provided a `dtype` option which is not a supported data type, the function throws an error (no parameters)', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - factory({ - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a first argument which is not a nonnegative integer (no parameters, options)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - -3, - 3.14, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, {} ); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory(); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function which throws an error if provided a `dtype` option which is not a supported data type (no parameters)', function test( t ) { - var random; - var values; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - values = [ - '5', - 5, - NaN, - true, - false, - null, - void 0, - {}, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws a type error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns a function for creating arrays containing pseudorandom numbers (default)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory(); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the first distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the second distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, NaN, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if the third distribution parameter is `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, 2.0, 5.0, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'when called without distribution parameters, the function returns a function which generates `NaN` values if all distribution parameters are `NaN`', function test( t ) { - var random; - var actual; - var i; - - random = factory(); - actual = random( 10, NaN, NaN, NaN ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( isnan( actual[ i ] ), true, 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying a PRNG seed', function test( t ) { - var random; - var arr1; - var arr2; - - random = factory( 2.0, 5.0, 3.0, { - 'seed': 12345 - }); - arr1 = random( 10 ); - - t.strictEqual( arr1 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr1.length, 10, 'returns expected value' ); - - random = factory({ - 'seed': 12345 - }); - arr2 = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( arr2 instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( arr2.length, 10, 'returns expected value' ); - - t.deepEqual( arr1, arr2, 'returns expected value' ); - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float64)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=float32)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float32' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - actual = random( 10 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'generic' - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the returned function supports overriding the default output array data type (dtype=generic)', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - actual = random( 10, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - - random = factory({ - 'dtype': 'float64' - }); - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Create another function using the captured state: - random = factory( 2.0, 5.0, 3.0, { - 'state': state - }); - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the returned function supports setting the generator state', function test( t ) { - var random; - var state; - var arr; - var i; - - random = factory( 2.0, 5.0, 3.0 ); - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10 ); - for ( i = 0; i < 100; i++ ) { - random( 2 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10 ), arr, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG', function test( t ) { - var random; - var actual; - var i; - - random = factory( 2.0, 5.0, 3.0, { - 'prng': minstd.normalized - }); - actual = random( 10 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports specifying the underlying PRNG (parameters)', function test( t ) { - var random; - var actual; - var i; - - random = factory({ - 'prng': minstd.normalized - }); - actual = random( 10, 2.0, 5.0, 3.0 ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value' ); - } - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory( 2.0, 5.0, 3.0, { - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10 ); - arr2 = random2( 10 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a seeded underlying PRNG (parameters)', function test( t ) { - var random1; - var random2; - var randu; - var seed; - var arr1; - var arr2; - - seed = 12345; - - randu = minstd.factory({ - 'seed': seed - }); - random1 = factory({ - 'prng': randu.normalized - }); - - randu = minstd.factory({ - 'seed': seed - }); - random2 = factory({ - 'prng': randu.normalized - }); - - t.notEqual( random1, random2, 'separate generators' ); - - arr1 = random1( 10, 2.0, 5.0, 3.0 ); - arr2 = random2( 10, 2.0, 5.0, 3.0 ); - t.deepEqual( arr1, arr2, 'returns expected value' ); - - t.end(); -}); - -tape( 'attached to the returned function is the underlying PRNG', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.PRNG, 'function', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.PRNG, minstd.normalized, 'has property' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (integer seed)', function test( t ) { - var random = factory({ - 'seed': 12345 - }); - t.strictEqual( isUint32Array( random.seed ), true, 'has property' ); - t.strictEqual( random.seed[ 0 ], 12345, 'equal to provided seed' ); - - random = factory({ - 'seed': 12345, - 'prng': minstd.normalized - }); - t.strictEqual( random.seed, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator seed (array seed)', function test( t ) { - var actual; - var rand; - var seed; - var i; - - seed = [ 1234, 5678 ]; - rand = factory({ - 'seed': seed - }); - - actual = rand.seed; - t.strictEqual( isUint32Array( actual ), true, 'has property' ); - for ( i = 0; i < seed.length; i++ ) { - t.strictEqual( actual[ i ], seed[ i ], 'returns expected value for word '+i ); - } - t.end(); -}); - -tape( 'attached to the returned function is the generator seed length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.seedLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.seedLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state', function test( t ) { - var random = factory(); - t.strictEqual( isUint32Array( random.state ), true, 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.state, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state length', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.stateLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.stateLength, null, 'returns expected value' ); - t.end(); -}); - -tape( 'attached to the returned function is the generator state size', function test( t ) { - var random = factory(); - t.strictEqual( typeof random.byteLength, 'number', 'has property' ); - - random = factory({ - 'prng': minstd.normalized - }); - t.strictEqual( random.byteLength, null, 'returns expected value' ); - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 7284b5c..0000000 --- a/test/test.js +++ /dev/null @@ -1,74 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2024 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var isUint32Array = require( '@stdlib/assert-is-uint32array' ); -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(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof random.assign, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is a `factory` method', function test( t ) { - t.strictEqual( typeof random.factory, 'function', 'has method' ); - t.end(); -}); - -tape( 'attached to the main export is the underlying PRNG', function test( t ) { - t.equal( typeof random.PRNG, 'function', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed', function test( t ) { - t.equal( isUint32Array( random.seed ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator seed length', function test( t ) { - t.equal( typeof random.seedLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state', function test( t ) { - t.equal( isUint32Array( random.state ), true, 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state length', function test( t ) { - t.equal( typeof random.stateLength, 'number', 'has property' ); - t.end(); -}); - -tape( 'attached to the main export is the generator state size', function test( t ) { - t.equal( typeof random.byteLength, 'number', 'has property' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e6944e2..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,244 +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 Float64Array = require( '@stdlib/array-float64' ); -var Float32Array = require( '@stdlib/array-float32' ); -var random = require( './../lib/main.js' ); - - -// 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(); -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0 ); - }; - } -}); - -tape( 'the function throws an error if provided a first argument which is not a nonnegative integer (options)', function test( t ) { - var values; - var i; - - values = [ - '5', - -5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( value, 2.0, 5.0, 3.0, {} ); - }; - } -}); - -tape( 'the function throws an error if provided an options argument which is not an object', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, value ); - }; - } -}); - -tape( 'the function throws an error if provided an invalid option', function test( t ) { - var values; - var i; - - values = [ - '5', - 5, - null, - true, - false, - void 0, - NaN, - [], - {}, - function noop() {} - ]; - - for ( i = 0; i < values.length; i++ ) { - t.throws( badValue( values[i] ), TypeError, 'throws an error when provided '+values[i] ); - } - t.end(); - - function badValue( value ) { - return function badValue() { - random( 10, 2.0, 5.0, 3.0, { - 'dtype': value - }); - }; - } -}); - -tape( 'the function returns an array containing pseudorandom numbers (default)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0 ); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float64)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float64' - }); - - t.strictEqual( actual instanceof Float64Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=float32)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'float32' - }); - - t.strictEqual( actual instanceof Float32Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( actual[ i ], actual[ i ], 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports specifying the output array data type (dtype=generic)', function test( t ) { - var actual; - var i; - - actual = random( 10, 2.0, 5.0, 3.0, { - 'dtype': 'generic' - }); - - t.strictEqual( actual instanceof Array, true, 'returns expected value' ); - t.strictEqual( actual.length, 10, 'returns expected value' ); - - for ( i = 0; i < actual.length; i++ ) { - t.strictEqual( typeof actual[ i ], 'number', 'returns expected value for index '+i ); - } - t.end(); -}); - -tape( 'the function supports setting the generator state', function test( t ) { - var state; - var arr; - var i; - - // Move to a future state... - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Capture the current state: - state = random.state; - - // Move to a future state... - arr = random( 10, 2.0, 5.0, 3.0 ); - for ( i = 0; i < 100; i++ ) { - random( 2, 2.0, 5.0, 3.0 ); - } - // Set the state: - random.state = state; - - // Replay previously generated values: - t.deepEqual( random( 10, 2.0, 5.0, 3.0 ), arr, 'returns expected value' ); - - t.end(); -}); pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy